{"docs":{"name":"HAQQ","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/apipie/1.0","api_url":"/api/v1","resources":{"import":{"doc_url":"/apipie/1.0/import","id":"import","api_url":"/api/v1","name":"Import","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/import/import_legal_matter_template","name":"import_legal_matter_template","apis":[{"api_url":"/api/v1/import/legal_matter/template","http_method":"GET","short_description":"Get import template for LegalMatter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_legal_matter","name":"import_legal_matter","apis":[{"api_url":"/api/v1/import/legal_matter","http_method":"POST","short_description":"Import LegalMatter","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"\n\u003cp\u003eSection stage for the import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_contact_template","name":"import_contact_template","apis":[{"api_url":"/api/v1/import/contact/template","http_method":"GET","short_description":"Get import template for Contact","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_contact","name":"import_contact","apis":[{"api_url":"/api/v1/import/contact","http_method":"POST","short_description":"Import Contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_hearing_template","name":"import_hearing_template","apis":[{"api_url":"/api/v1/import/hearing/template","http_method":"GET","short_description":"Get import template for Hearing","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_hearing","name":"import_hearing","apis":[{"api_url":"/api/v1/import/hearing","http_method":"POST","short_description":"Import Hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_chart_of_account_template","name":"import_financial_chart_of_account_template","apis":[{"api_url":"/api/v1/import/financial/chart_of_account/template","http_method":"GET","short_description":"Get import template for Financial::ChartOfAccount","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_chart_of_account","name":"import_financial_chart_of_account","apis":[{"api_url":"/api/v1/import/financial/chart_of_account","http_method":"POST","short_description":"Import Financial::ChartOfAccount","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_expense_template","name":"import_financial_expense_template","apis":[{"api_url":"/api/v1/import/financial/expense/template","http_method":"GET","short_description":"Get import template for Financial::Expense","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_expense","name":"import_financial_expense","apis":[{"api_url":"/api/v1/import/financial/expense","http_method":"POST","short_description":"Import Financial::Expense","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_receipt_template","name":"import_financial_receipt_template","apis":[{"api_url":"/api/v1/import/financial/receipt/template","http_method":"GET","short_description":"Get import template for Financial::Receipt","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_receipt","name":"import_financial_receipt","apis":[{"api_url":"/api/v1/import/financial/receipt","http_method":"POST","short_description":"Import Financial::Receipt","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_calendar_item_template","name":"import_calendar_item_template","apis":[{"api_url":"/api/v1/import/calendar_item/template","http_method":"GET","short_description":"Get import template for CalendarItem","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_calendar_item","name":"import_calendar_item","apis":[{"api_url":"/api/v1/import/calendar_item","http_method":"POST","short_description":"Import CalendarItem","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_journal_entry_template","name":"import_financial_journal_entry_template","apis":[{"api_url":"/api/v1/import/financial/journal_entry/template","http_method":"GET","short_description":"Get import template for Financial::JournalEntry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_journal_entry","name":"import_financial_journal_entry","apis":[{"api_url":"/api/v1/import/financial/journal_entry","http_method":"POST","short_description":"Import Financial::JournalEntry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_invoice_template","name":"import_financial_invoice_template","apis":[{"api_url":"/api/v1/import/financial/invoice/template","http_method":"GET","short_description":"Get import template for Financial::Invoice","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/import/import_financial_invoice","name":"import_financial_invoice","apis":[{"api_url":"/api/v1/import/financial/invoice","http_method":"POST","short_description":"Import Financial::Invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to import\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_type","full_name":"file_type","description":"\n\u003cp\u003eType of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003exlsx\u003c/code\u003e, \u003ccode\u003ecsv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"notifications":{"doc_url":"/apipie/1.0/notifications","id":"notifications","api_url":"/api/v1","name":"Notifications","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/notifications/send_notification","name":"send_notification","apis":[{"api_url":"/api/v1/internal/notifications/send","http_method":"POST","short_description":"Send a push notification to a user (internal system-to-system API)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eThe user ID to send the notification to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eNotification title\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"body","full_name":"body","description":"\n\u003cp\u003eNotification body\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eAdditional data payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image","full_name":"image","description":"\n\u003cp\u003eImage URL for the notification\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/notifications/index","name":"index","apis":[{"api_url":"/api/v1/notifications","http_method":"GET","short_description":"Get notifications for a user in the current workspace","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"notification_group_type","full_name":"notification_group_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eclient_related\u003c/code\u003e, \u003ccode\u003einternal\u003c/code\u003e, \u003ccode\u003ebilling_and_financial\u003c/code\u003e, \u003ccode\u003ecalendar_and_deadline\u003c/code\u003e, \u003ccode\u003egeneral\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unviewed_only","full_name":"unviewed_only","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/notifications/create","name":"create","apis":[{"api_url":"/api/v1/notifications","http_method":"POST","short_description":"Send a notification to myself","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"title","full_name":"title","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"body","full_name":"body","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"action_cable":{"doc_url":"/apipie/1.0/action_cable","id":"action_cable","api_url":"/api/v1","name":"Action_cable","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/action_cable/token","name":"token","apis":[{"api_url":"/api/v1/action_cable/token","http_method":"GET","short_description":"Get action cable token","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"announcements":{"doc_url":"/apipie/1.0/announcements","id":"announcements","api_url":"/api/v1","name":"Announcements","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/announcements/index","name":"index","apis":[{"api_url":"/api/v1/announcements","http_method":"GET","short_description":"Get all announcements for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eSearch keyword\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"published","full_name":"published","description":"\n\u003cp\u003eFilter by published status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority","full_name":"priority","description":"\n\u003cp\u003eFilter by priority\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eimportant\u003c/code\u003e, \u003ccode\u003eurgent\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/announcements/currently_active","name":"currently_active","apis":[{"api_url":"/api/v1/announcements/currently_active","http_method":"GET","short_description":"Get currently active announcements","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/announcements/create","name":"create","apis":[{"api_url":"/api/v1/announcements","http_method":"POST","short_description":"Create an announcement","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"title","full_name":"title","description":"\n\u003cp\u003eAnnouncement title\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eAnnouncement description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_from","full_name":"date_from","description":"\n\u003cp\u003eStart date (ISO 8601)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_to","full_name":"date_to","description":"\n\u003cp\u003eEnd date (ISO 8601)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"published","full_name":"published","description":"\n\u003cp\u003eWhether the announcement is published\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority","full_name":"priority","description":"\n\u003cp\u003eAnnouncement priority\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eimportant\u003c/code\u003e, \u003ccode\u003eurgent\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image","full_name":"image","description":"\n\u003cp\u003eAnnouncement image\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/announcements/show","name":"show","apis":[{"api_url":"/api/v1/announcements/:id","http_method":"GET","short_description":"Get an announcement","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/announcements/update","name":"update","apis":[{"api_url":"/api/v1/announcements/:id","http_method":"PUT","short_description":"Update an announcement","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eAnnouncement title\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eAnnouncement description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_from","full_name":"date_from","description":"\n\u003cp\u003eStart date (ISO 8601)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_to","full_name":"date_to","description":"\n\u003cp\u003eEnd date (ISO 8601)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"published","full_name":"published","description":"\n\u003cp\u003eWhether the announcement is published\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority","full_name":"priority","description":"\n\u003cp\u003eAnnouncement priority\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eimportant\u003c/code\u003e, \u003ccode\u003eurgent\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image","full_name":"image","description":"\n\u003cp\u003eAnnouncement image\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/announcements/destroy","name":"destroy","apis":[{"api_url":"/api/v1/announcements/:id","http_method":"DELETE","short_description":"Delete an announcement","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"authentication":{"doc_url":"/apipie/1.0/authentication","id":"authentication","api_url":"/api/v1","name":"Authentication","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/authentication/login","name":"login","apis":[{"api_url":"/api/v1/authentication/login","http_method":"POST","short_description":"Login user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eemail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003epassword\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/authentication/create","name":"create","apis":[{"api_url":"/api/v1/authentication/register","http_method":"POST","short_description":"Create user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eemail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003epassword\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_tags","full_name":"utm_tags","description":"\n\u003cp\u003eUTM tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"utm_source","full_name":"utm_tags[utm_source]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_medium","full_name":"utm_tags[utm_medium]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_campaign","full_name":"utm_tags[utm_campaign]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_content","full_name":"utm_tags[utm_content]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_term","full_name":"utm_tags[utm_term]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_adset","full_name":"utm_tags[utm_adset]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_id","full_name":"utm_tags[utm_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/authentication/send_email_otp","name":"send_email_otp","apis":[{"api_url":"/api/v1/authentication/via_otp","http_method":"GET","short_description":"Send OTP to user email","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_tags","full_name":"utm_tags","description":"\n\u003cp\u003eUTM tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"utm_source","full_name":"utm_tags[utm_source]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_medium","full_name":"utm_tags[utm_medium]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_campaign","full_name":"utm_tags[utm_campaign]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_content","full_name":"utm_tags[utm_content]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_term","full_name":"utm_tags[utm_term]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_adset","full_name":"utm_tags[utm_adset]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utm_id","full_name":"utm_tags[utm_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/authentication/validate_email_otp","name":"validate_email_otp","apis":[{"api_url":"/api/v1/authentication/via_otp","http_method":"POST","short_description":"Validate email OTP","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"otp_code","full_name":"otp_code","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/authentication/logout","name":"logout","apis":[{"api_url":"/api/v1/authentication/logout","http_method":"DELETE","short_description":"Logout user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bulk":{"doc_url":"/apipie/1.0/bulk","id":"bulk","api_url":"/api/v1","name":"Bulk","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/bulk/bulk_delete","name":"bulk_delete","apis":[{"api_url":"/api/v1/bulk/:model","http_method":"DELETE","short_description":"Bulk delete records","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of record IDs to delete\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/bulk/bulk_update","name":"bulk_update","apis":[{"api_url":"/api/v1/bulk/:model","http_method":"PATCH","short_description":"Bulk update records","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of record IDs to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"attributes","description":"\n\u003cp\u003eAttributes to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/bulk/bulk_archive","name":"bulk_archive","apis":[{"api_url":"/api/v1/bulk/:model/archive","http_method":"PATCH","short_description":"Bulk archive records","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of record IDs to archive\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/bulk/bulk_unarchive","name":"bulk_unarchive","apis":[{"api_url":"/api/v1/bulk/:model/archive","http_method":"DELETE","short_description":"Bulk unarchive records","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of record IDs to unarchive\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/bulk/update","name":"update","apis":[{"api_url":"/api/v1/sections/:section_id/stages/bulk","http_method":"PUT","short_description":"Bulk stages fixing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"stages","full_name":"stages","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"stages[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"stages[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"stages[sort_order]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"stages[color]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"form_columns","full_name":"stages[form_columns]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"index","full_name":"stages[form_columns][index]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"stages[form_columns][columns]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"stages[form_columns][columns][name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"stages[form_columns][columns][required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"calendar_items":{"doc_url":"/apipie/1.0/calendar_items","id":"calendar_items","api_url":"/api/v1","name":"Calendar_items","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/calendar_items/index","name":"index","apis":[{"api_url":"/api/v1/calendar_items","http_method":"GET","short_description":"Get all calendar items for current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_after","full_name":"start_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_before","full_name":"start_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_after","full_name":"end_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_before","full_name":"end_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_limit","full_name":"skip_limit","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_user_id","full_name":"company_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_type_id","full_name":"item_type_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_type","full_name":"linked_item_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_id","full_name":"linked_item_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_user","full_name":"with_user","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"private","full_name":"private","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable","full_name":"billable","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoiced","full_name":"invoiced","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_timesheet","full_name":"show_in_timesheet","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_contact_id","full_name":"related_to_contact_id","description":"\n\u003cp\u003eReturn all calendar items where contact_id matches: (calendar item linked_item for contact_id) or (linked_item of type legal matter and for contact_id) or (linked_item of type hearing for contact_id)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_conversions","full_name":"with_conversions","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_extra_data","full_name":"with_extra_data","description":"\n\u003cp\u003eWhether to include extra data to render on the calendar\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/calendar_items/create","name":"create","apis":[{"api_url":"/api/v1/calendar_items","http_method":"POST","short_description":"Create a new calendar item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_time","full_name":"start_time","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"end_time","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total_time_spent_seconds","full_name":"total_time_spent_seconds","description":"\n\u003cp\u003eNot used if end_time is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable","full_name":"billable","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_type_id","full_name":"item_type_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_day","full_name":"all_day","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_range","full_name":"time_range","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"private","full_name":"private","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"send_reminder_at","full_name":"send_reminder_at","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"location","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"link_urls","full_name":"link_urls","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_timesheet","full_name":"show_in_timesheet","description":"\n\u003cp\u003eWhether to show this item in the timesheet. Defaults to false. Must be true for billable items.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calendar_item_linked_items_attributes","full_name":"calendar_item_linked_items_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"linked_item_id","full_name":"calendar_item_linked_items_attributes[linked_item_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_type","full_name":"calendar_item_linked_items_attributes[linked_item_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"calendar_item_attendees_attributes","full_name":"calendar_item_attendees_attributes","description":"\n\u003cp\u003eArray of attendees\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"attendee_type","full_name":"calendar_item_attendees_attributes[attendee_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eExternalEmail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attendee_id","full_name":"calendar_item_attendees_attributes[attendee_id]","description":"\n\u003cp\u003eID of the attendee if they are a User or Contact\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"calendar_item_attendees_attributes[email]","description":"\n\u003cp\u003eEmail address of the attendee\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"reminders","full_name":"reminders","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"remind_at","full_name":"reminders[remind_at]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"reminders[title]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"reminders[description]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"custom_created_at","full_name":"custom_created_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/calendar_items/show","name":"show","apis":[{"api_url":"/api/v1/calendar_items/:id","http_method":"GET","short_description":"Get a calendar item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_user","full_name":"with_user","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/calendar_items/update","name":"update","apis":[{"api_url":"/api/v1/calendar_items/:id","http_method":"PUT","short_description":"Update a calendar item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_time","full_name":"start_time","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"end_time","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total_time_spent_seconds","full_name":"total_time_spent_seconds","description":"\n\u003cp\u003eNot used if end_time is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable","full_name":"billable","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_type_id","full_name":"item_type_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_day","full_name":"all_day","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_range","full_name":"time_range","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"private","full_name":"private","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"send_reminder_at","full_name":"send_reminder_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"location","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"link_urls","full_name":"link_urls","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_timesheet","full_name":"show_in_timesheet","description":"\n\u003cp\u003eWhether to show this item in the timesheet. Must be true for billable items.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calendar_item_linked_items_attributes","full_name":"calendar_item_linked_items_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"calendar_item_linked_items_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"calendar_item_linked_items_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_id","full_name":"calendar_item_linked_items_attributes[linked_item_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_type","full_name":"calendar_item_linked_items_attributes[linked_item_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"calendar_item_attendees_attributes","full_name":"calendar_item_attendees_attributes","description":"\n\u003cp\u003eArray of attendees\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"calendar_item_attendees_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"calendar_item_attendees_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attendee_type","full_name":"calendar_item_attendees_attributes[attendee_type]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eExternalEmail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attendee_id","full_name":"calendar_item_attendees_attributes[attendee_id]","description":"\n\u003cp\u003eID of the attendee if they are a User or Contact\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"calendar_item_attendees_attributes[email]","description":"\n\u003cp\u003eEmail address of the attendee\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"reminders","full_name":"reminders","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"reminders[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"reminders[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remind_at","full_name":"reminders[remind_at]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"reminders[title]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"reminders[description]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"custom_created_at","full_name":"custom_created_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/calendar_items/destroy","name":"destroy","apis":[{"api_url":"/api/v1/calendar_items/:id","http_method":"DELETE","short_description":"Delete a calendar item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"cities":{"doc_url":"/apipie/1.0/cities","id":"cities","api_url":"/api/v1","name":"Cities","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/cities/by_state","name":"by_state","apis":[{"api_url":"/api/v1/cities/by_state/:state_id","http_method":"GET","short_description":"List cities by state","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"state_id","full_name":"state_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"companies":{"doc_url":"/apipie/1.0/companies","id":"companies","api_url":"/api/v1","name":"Companies","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/companies/create","name":"create","apis":[{"api_url":"/api/v1/companies","http_method":"POST","short_description":"Create a new company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"country_id","full_name":"country_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"logo","full_name":"logo","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_identification_number","full_name":"tax_identification_number","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_percentage","full_name":"tax_percentage","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_for_calendar_view","full_name":"permission_for_calendar_view","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eonly_admins\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_for_task_view","full_name":"permission_for_task_view","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eonly_assigned\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billing_email","full_name":"billing_email","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_addresses","full_name":"email_addresses","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"email_addresses[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"email_addresses[email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"phone_numbers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"phone_numbers[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_numbers[phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/companies/show","name":"show","apis":[{"api_url":"/api/v1/companies/:id","http_method":"GET","short_description":"Get company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/companies/update","name":"update","apis":[{"api_url":"/api/v1/companies/:id","http_method":"PUT","short_description":"Update company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_identification_number","full_name":"tax_identification_number","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_percentage","full_name":"tax_percentage","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"logo","full_name":"logo","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"logo_detach","full_name":"logo_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_logo","full_name":"invoice_logo","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_logo_detach","full_name":"invoice_logo_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matter_starting_id","full_name":"legal_matter_starting_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hearing_starting_id","full_name":"hearing_starting_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_for_calendar_view","full_name":"permission_for_calendar_view","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eonly_admins\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_for_task_view","full_name":"permission_for_task_view","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eonly_assigned\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_expense","full_name":"have_folder_for_every_expense","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_hearing","full_name":"have_folder_for_every_hearing","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_milestone","full_name":"have_folder_for_every_milestone","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_task","full_name":"have_folder_for_every_task","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_contact","full_name":"have_folder_for_every_contact","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_company_user","full_name":"have_folder_for_every_company_user","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_lead","full_name":"have_folder_for_every_lead","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"have_folder_for_every_legal_matter","full_name":"have_folder_for_every_legal_matter","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_enabled","full_name":"ai_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_auto_checkout_enabled","full_name":"hr_auto_checkout_enabled","description":"\n\u003cp\u003eEnable HR auto-checkout\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_fiscal_year_start_month","full_name":"hr_fiscal_year_start_month","description":"\n\u003cp\u003eHR fiscal year start month (1-12)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_addresses","full_name":"email_addresses","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"email_addresses[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"email_addresses[email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"phone_numbers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"phone_numbers[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_numbers[phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/companies/destroy","name":"destroy","apis":[{"api_url":"/api/v1/companies/:id","http_method":"DELETE","short_description":"Delete company with OTP verification","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"otp_code","full_name":"otp_code","description":"\n\u003cp\u003e6-digit OTP code received for deletion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"company_billing_profiles":{"doc_url":"/apipie/1.0/company_billing_profiles","id":"company_billing_profiles","api_url":"/api/v1","name":"Company_billing_profiles","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/company_billing_profiles/index","name":"index","apis":[{"api_url":"/api/v1/company_billing_profiles","http_method":"GET","short_description":"Get all company_billing_profiles for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eKeyword to search by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_billing_profiles/create","name":"create","apis":[{"api_url":"/api/v1/company_billing_profiles","http_method":"POST","short_description":"Create a new company billing profile","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone","full_name":"phone","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"street_address","full_name":"street_address","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_line_2","full_name":"address_line_2","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"city","full_name":"city","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_or_province","full_name":"state_or_province","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"postal_code","full_name":"postal_code","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"country","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_identification","full_name":"tax_identification","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_legal_name","full_name":"company_legal_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registration_number","full_name":"registration_number","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_person_name","full_name":"contact_person_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billing_notes","full_name":"billing_notes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_billing_profiles/show","name":"show","apis":[{"api_url":"/api/v1/company_billing_profiles/:id","http_method":"GET","short_description":"Get a company billing profile","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_billing_profiles/update","name":"update","apis":[{"api_url":"/api/v1/company_billing_profiles/:id","http_method":"PUT","short_description":"Update a company billing profile","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone","full_name":"phone","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"street_address","full_name":"street_address","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_line_2","full_name":"address_line_2","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"city","full_name":"city","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_or_province","full_name":"state_or_province","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"postal_code","full_name":"postal_code","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"country","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_identification","full_name":"tax_identification","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_legal_name","full_name":"company_legal_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registration_number","full_name":"registration_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_person_name","full_name":"contact_person_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billing_notes","full_name":"billing_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_billing_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/v1/company_billing_profiles/:id","http_method":"DELETE","short_description":"Delete a company billing profile","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"company_configurations":{"doc_url":"/apipie/1.0/company_configurations","id":"company_configurations","api_url":"/api/v1","name":"Company_configurations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/company_configurations/index","name":"index","apis":[{"api_url":"/api/v1/company_configurations","http_method":"GET","short_description":"Get all company_configurations for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"configuration_type","full_name":"configuration_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecourt\u003c/code\u003e, \u003ccode\u003elegal_matter_status\u003c/code\u003e, \u003ccode\u003elegal_matter_specialization\u003c/code\u003e, \u003ccode\u003elegal_matter_category\u003c/code\u003e, \u003ccode\u003elegal_matter_sector\u003c/code\u003e, \u003ccode\u003elegal_matter_representation_type\u003c/code\u003e, \u003ccode\u003ehearing_status\u003c/code\u003e, \u003ccode\u003ehearing_reschedule_reason\u003c/code\u003e, \u003ccode\u003etask_priority\u003c/code\u003e, \u003ccode\u003etask_status\u003c/code\u003e, \u003ccode\u003emilestone_status\u003c/code\u003e, \u003ccode\u003ecalendar_item_type\u003c/code\u003e, \u003ccode\u003einvoice_template\u003c/code\u003e, \u003ccode\u003eexpense_template\u003c/code\u003e, \u003ccode\u003ereceipt_template\u003c/code\u003e, \u003ccode\u003ehr_training_category\u003c/code\u003e, \u003ccode\u003eorganization_contact_organization_type\u003c/code\u003e, \u003ccode\u003eorganization_contact_organization_industry\u003c/code\u003e, \u003ccode\u003elead_label\u003c/code\u003e, \u003ccode\u003econtact_label\u003c/code\u003e, \u003ccode\u003etask_label\u003c/code\u003e, \u003ccode\u003estorage_file_label\u003c/code\u003e, \u003ccode\u003estorage_folder_label\u003c/code\u003e, \u003ccode\u003eindividual_contact_form_fields\u003c/code\u003e, \u003ccode\u003eorganization_contact_form_fields\u003c/code\u003e, \u003ccode\u003ehearings_form_fields\u003c/code\u003e, \u003ccode\u003emilestone_form_fields\u003c/code\u003e, \u003ccode\u003esharepoint_site_id\u003c/code\u003e, \u003ccode\u003esharepoint_documents_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_legal_matters_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_hearings_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_leads_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_contacts_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_tasks_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_expenses_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_milestones_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_company_users_folder_id\u003c/code\u003e, \u003ccode\u003edefault_folders_on_company_user_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_contact_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_expense_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_hearing_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_lead_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_legal_matter_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_milestone_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_task_create\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_organization_contact\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_individual_contact\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_hearing\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_lead\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_legal_matter\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_milestone\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_task\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_financial_journal_entry\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_company_user\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_company_user\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_contact\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_hearing\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_lead\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_legal_matter\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_milestone\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_task\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_financial_expense\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_configurations/create","name":"create","apis":[{"api_url":"/api/v1/company_configurations","http_method":"POST","short_description":"Create a new company configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"configuration_type","full_name":"configuration_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecourt\u003c/code\u003e, \u003ccode\u003elegal_matter_status\u003c/code\u003e, \u003ccode\u003elegal_matter_specialization\u003c/code\u003e, \u003ccode\u003elegal_matter_category\u003c/code\u003e, \u003ccode\u003elegal_matter_sector\u003c/code\u003e, \u003ccode\u003elegal_matter_representation_type\u003c/code\u003e, \u003ccode\u003ehearing_status\u003c/code\u003e, \u003ccode\u003ehearing_reschedule_reason\u003c/code\u003e, \u003ccode\u003etask_priority\u003c/code\u003e, \u003ccode\u003etask_status\u003c/code\u003e, \u003ccode\u003emilestone_status\u003c/code\u003e, \u003ccode\u003ecalendar_item_type\u003c/code\u003e, \u003ccode\u003einvoice_template\u003c/code\u003e, \u003ccode\u003eexpense_template\u003c/code\u003e, \u003ccode\u003ereceipt_template\u003c/code\u003e, \u003ccode\u003ehr_training_category\u003c/code\u003e, \u003ccode\u003eorganization_contact_organization_type\u003c/code\u003e, \u003ccode\u003eorganization_contact_organization_industry\u003c/code\u003e, \u003ccode\u003elead_label\u003c/code\u003e, \u003ccode\u003econtact_label\u003c/code\u003e, \u003ccode\u003etask_label\u003c/code\u003e, \u003ccode\u003estorage_file_label\u003c/code\u003e, \u003ccode\u003estorage_folder_label\u003c/code\u003e, \u003ccode\u003eindividual_contact_form_fields\u003c/code\u003e, \u003ccode\u003eorganization_contact_form_fields\u003c/code\u003e, \u003ccode\u003ehearings_form_fields\u003c/code\u003e, \u003ccode\u003emilestone_form_fields\u003c/code\u003e, \u003ccode\u003esharepoint_site_id\u003c/code\u003e, \u003ccode\u003esharepoint_documents_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_legal_matters_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_hearings_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_leads_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_contacts_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_tasks_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_expenses_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_milestones_folder_id\u003c/code\u003e, \u003ccode\u003esharepoint_company_users_folder_id\u003c/code\u003e, \u003ccode\u003edefault_folders_on_company_user_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_contact_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_expense_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_hearing_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_lead_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_legal_matter_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_milestone_create\u003c/code\u003e, \u003ccode\u003edefault_folders_on_task_create\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_organization_contact\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_individual_contact\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_hearing\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_lead\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_legal_matter\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_milestone\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_task\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_financial_journal_entry\u003c/code\u003e, \u003ccode\u003ecustom_id_format_for_company_user\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_company_user\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_contact\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_hearing\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_lead\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_legal_matter\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_milestone\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_task\u003c/code\u003e, \u003ccode\u003estorage_folder_name_format_for_financial_expense\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"icon_name","full_name":"icon_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_configurations/show","name":"show","apis":[{"api_url":"/api/v1/company_configurations/:id","http_method":"GET","short_description":"Get a company configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_configurations/update","name":"update","apis":[{"api_url":"/api/v1/company_configurations/:id","http_method":"PUT","short_description":"Update a company configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"icon_name","full_name":"icon_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_configurations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/company_configurations/:id","http_method":"DELETE","short_description":"Delete a company configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"company_exports":{"doc_url":"/apipie/1.0/company_exports","id":"company_exports","api_url":"/api/v1","name":"Company_exports","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/company_exports/create","name":"create","apis":[{"api_url":"/api/v1/companies/:company_id/exports","http_method":"POST","short_description":"Trigger a full company data export to Excel","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the company to export\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recipient_emails","full_name":"recipient_emails","description":"\n\u003cp\u003eList of email addresses to notify when export is ready\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"company_user_configurations":{"doc_url":"/apipie/1.0/company_user_configurations","id":"company_user_configurations","api_url":"/api/v1","name":"Company_user_configurations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/company_user_configurations/index","name":"index","apis":[{"api_url":"/api/v1/company_user_configurations","http_method":"GET","short_description":"Get all company_user_configurations for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"configuration_type","full_name":"configuration_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emenu_structure\u003c/code\u003e, \u003ccode\u003eall_contacts_table_columns\u003c/code\u003e, \u003ccode\u003eindividual_contact_table_columns\u003c/code\u003e, \u003ccode\u003eorganization_contact_table_columns\u003c/code\u003e, \u003ccode\u003elegal_matters_all_table_columns\u003c/code\u003e, \u003ccode\u003ehearings_all_table_columns\u003c/code\u003e, \u003ccode\u003etasks_all_table_columns\u003c/code\u003e, \u003ccode\u003emilestone_all_table_columns\u003c/code\u003e, \u003ccode\u003eleads_all_table_columns\u003c/code\u003e, \u003ccode\u003eexpenses_all_table_columns\u003c/code\u003e, \u003ccode\u003einvoices_all_table_columns\u003c/code\u003e, \u003ccode\u003etime_sheet_table_columns\u003c/code\u003e, \u003ccode\u003epayments_table_columns\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_user_configurations/create","name":"create","apis":[{"api_url":"/api/v1/company_user_configurations","http_method":"POST","short_description":"Create a new company user configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"configuration_type","full_name":"configuration_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emenu_structure\u003c/code\u003e, \u003ccode\u003eall_contacts_table_columns\u003c/code\u003e, \u003ccode\u003eindividual_contact_table_columns\u003c/code\u003e, \u003ccode\u003eorganization_contact_table_columns\u003c/code\u003e, \u003ccode\u003elegal_matters_all_table_columns\u003c/code\u003e, \u003ccode\u003ehearings_all_table_columns\u003c/code\u003e, \u003ccode\u003etasks_all_table_columns\u003c/code\u003e, \u003ccode\u003emilestone_all_table_columns\u003c/code\u003e, \u003ccode\u003eleads_all_table_columns\u003c/code\u003e, \u003ccode\u003eexpenses_all_table_columns\u003c/code\u003e, \u003ccode\u003einvoices_all_table_columns\u003c/code\u003e, \u003ccode\u003etime_sheet_table_columns\u003c/code\u003e, \u003ccode\u003epayments_table_columns\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"icon_name","full_name":"icon_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_user_configurations/show","name":"show","apis":[{"api_url":"/api/v1/company_user_configurations/:id","http_method":"GET","short_description":"Get a company user configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_user_configurations/update","name":"update","apis":[{"api_url":"/api/v1/company_user_configurations/:id","http_method":"PUT","short_description":"Update a company user configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"icon_name","full_name":"icon_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_user_configurations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/company_user_configurations/:id","http_method":"DELETE","short_description":"Delete a company user configuration","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"company_users":{"doc_url":"/apipie/1.0/company_users","id":"company_users","api_url":"/api/v1","name":"Company_users","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/company_users/index","name":"index","apis":[{"api_url":"/api/v1/companies/:id/users","http_method":"GET","short_description":"Get users","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"as_company_user","full_name":"as_company_user","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_users/create","name":"create","apis":[{"api_url":"/api/v1/companies/:id/users","http_method":"POST","short_description":"Add user to company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"middle_name","full_name":"middle_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"position","full_name":"position","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_ids","full_name":"role_ids","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"join_date","full_name":"join_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leave_date","full_name":"leave_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leave_reason","full_name":"leave_reason","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contract_type","full_name":"contract_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bar_id","full_name":"bar_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_users/show","name":"show","apis":[{"api_url":"/api/v1/companies/:id/users/:company_user_id","http_method":"GET","short_description":"Get user in company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_users/show_by_user_id","name":"show_by_user_id","apis":[{"api_url":"/api/v1/companies/:id/users/by_user_id/:user_id","http_method":"GET","short_description":"Get user in company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_users/update","name":"update","apis":[{"api_url":"/api/v1/companies/:id/users/:company_user_id","http_method":"PUT","short_description":"Update user in company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_user_id","full_name":"company_user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"basic_salary_amount","full_name":"basic_salary_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"basic_salary_currency_id","full_name":"basic_salary_currency_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"basic_salary_frequency","full_name":"basic_salary_frequency","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ebiweekly\u003c/code\u003e, \u003ccode\u003emonthly\u003c/code\u003e, \u003ccode\u003equarterly\u003c/code\u003e, \u003ccode\u003eannually\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_hourly_rate_earning_amount","full_name":"billable_hourly_rate_earning_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_hourly_rate_earning_currency_id","full_name":"billable_hourly_rate_earning_currency_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_hourly_rate_charging_amount","full_name":"billable_hourly_rate_charging_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_hourly_rate_charging_currency_id","full_name":"billable_hourly_rate_charging_currency_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calendar_timezones","full_name":"calendar_timezones","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_ids","full_name":"role_ids","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"position","full_name":"position","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"join_date","full_name":"join_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leave_date","full_name":"leave_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leave_reason","full_name":"leave_reason","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contract_type","full_name":"contract_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bar_id","full_name":"bar_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/company_users/destroy","name":"destroy","apis":[{"api_url":"/api/v1/companies/:id/users/:company_user_id","http_method":"DELETE","short_description":"Remove user from company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_user_id","full_name":"company_user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"connected_accounts":{"doc_url":"/apipie/1.0/connected_accounts","id":"connected_accounts","api_url":"/api/v1","name":"Connected_accounts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/connected_accounts/index","name":"index","apis":[{"api_url":"/api/v1/connected_accounts","http_method":"GET","short_description":"Get connected accounts","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"provider","full_name":"provider","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emicrosoft\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_name","full_name":"service_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecalendar\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/connected_accounts/destroy","name":"destroy","apis":[{"api_url":"/api/v1/connected_accounts/:id","http_method":"DELETE","short_description":"Delete a connected account","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"contacts":{"doc_url":"/apipie/1.0/contacts","id":"contacts","api_url":"/api/v1","name":"Contacts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/contacts/index","name":"index","apis":[{"api_url":"/api/v1/contacts","http_method":"GET","short_description":"Get all contacts for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_type","full_name":"contact_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eIndividualContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"client","full_name":"client","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_active_legal_matters","full_name":"has_active_legal_matters","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_id","full_name":"designated_point_of_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_type","full_name":"designated_point_of_contact_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_user_id","full_name":"all_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppliers","full_name":"suppliers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_user_id","full_name":"linked_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/contacts/show","name":"show","apis":[{"api_url":"/api/v1/contacts/:id","http_method":"GET","short_description":"Get a contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/contacts/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contacts/:id","http_method":"DELETE","short_description":"Delete a contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"countries":{"doc_url":"/apipie/1.0/countries","id":"countries","api_url":"/api/v1","name":"Countries","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/countries/index","name":"index","apis":[{"api_url":"/api/v1/countries","http_method":"GET","short_description":"List all countries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"currencies":{"doc_url":"/apipie/1.0/currencies","id":"currencies","api_url":"/api/v1","name":"Currencies","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/currencies/index","name":"index","apis":[{"api_url":"/api/v1/currencies","http_method":"GET","short_description":"Get all currencies for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/currencies/create","name":"create","apis":[{"api_url":"/api/v1/currencies","http_method":"POST","short_description":"Create a currency","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"conversion_rate_against_default_currency","full_name":"conversion_rate_against_default_currency","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/currencies/show","name":"show","apis":[{"api_url":"/api/v1/currencies/:id","http_method":"GET","short_description":"Get a currency","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/currencies/update","name":"update","apis":[{"api_url":"/api/v1/currencies/:id","http_method":"PUT","short_description":"Update a currency","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"conversion_rate_against_default_currency","full_name":"conversion_rate_against_default_currency","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/currencies/destroy","name":"destroy","apis":[{"api_url":"/api/v1/currencies/:id","http_method":"DELETE","short_description":"Delete a currency","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"/apipie/1.0/dashboard","id":"dashboard","api_url":"/api/v1","name":"Dashboard","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/dashboard/index","name":"index","apis":[{"api_url":"/api/v1/dashboard","http_method":"GET","short_description":"Get dashboard data for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"exports":{"doc_url":"/apipie/1.0/exports","id":"exports","api_url":"/api/v1","name":"Exports","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/exports/index","name":"index","apis":[{"api_url":"/api/v1/exports","http_method":"GET","short_description":"Get all exports for current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by status (pending, processing, completed, failed)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/exports/show","name":"show","apis":[{"api_url":"/api/v1/exports/:id","http_method":"GET","short_description":"Get an export","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"general":{"doc_url":"/apipie/1.0/general","id":"general","api_url":"/api/v1","name":"General","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/general/status","name":"status","apis":[{"api_url":"/api/v1/general/status","http_method":"GET","short_description":"Get status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/general/data","name":"data","apis":[{"api_url":"/api/v1/general/data","http_method":"GET","short_description":"Get all default data","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hearing_reschedules":{"doc_url":"/apipie/1.0/hearing_reschedules","id":"hearing_reschedules","api_url":"/api/v1","name":"Hearing_reschedules","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/hearing_reschedules/index","name":"index","apis":[{"api_url":"/api/v1/hearings/:id/reschedules","http_method":"GET","short_description":"Get all reschedules for a hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/hearing_reschedules/create","name":"create","apis":[{"api_url":"/api/v1/hearings/:id/reschedules","http_method":"POST","short_description":"Create a hearing reschedule","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date of the hearing\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date of the hearing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason_id","full_name":"reason_id","description":"\n\u003cp\u003eReason for rescheduling the hearing\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"hearings":{"doc_url":"/apipie/1.0/hearings","id":"hearings","api_url":"/api/v1","name":"Hearings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/hearings/index","name":"index","apis":[{"api_url":"/api/v1/hearings","http_method":"GET","short_description":"Get all hearings for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matter_id","full_name":"legal_matter_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_contact_id","full_name":"all_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_user_id","full_name":"all_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/hearings/create","name":"create","apis":[{"api_url":"/api/v1/hearings","http_method":"POST","short_description":"Create a hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matter_id","full_name":"legal_matter_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"\n\u003cp\u003eUser\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_id","full_name":"court_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_case_number","full_name":"court_case_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jurisdiction_id","full_name":"jurisdiction_id","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region","full_name":"region","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lawyer_users","full_name":"lawyer_users","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"lawyer_users[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"lawyer_users[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"participant_contact_ids","full_name":"participant_contact_ids","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_created_at","full_name":"custom_created_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/hearings/show","name":"show","apis":[{"api_url":"/api/v1/hearings/:id","http_method":"GET","short_description":"Get a hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/hearings/update","name":"update","apis":[{"api_url":"/api/v1/hearings/:id","http_method":"PUT","short_description":"Update a hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"\n\u003cp\u003eUser\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_id","full_name":"court_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_case_number","full_name":"court_case_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jurisdiction_id","full_name":"jurisdiction_id","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region","full_name":"region","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lawyer_users","full_name":"lawyer_users","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"lawyer_users[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"lawyer_users[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"participant_contact_ids","full_name":"participant_contact_ids","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_created_at","full_name":"custom_created_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/hearings/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hearings/:id","http_method":"DELETE","short_description":"Delete a hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"individual_contacts":{"doc_url":"/apipie/1.0/individual_contacts","id":"individual_contacts","api_url":"/api/v1","name":"Individual_contacts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/individual_contacts/create","name":"create","apis":[{"api_url":"/api/v1/contacts/individuals","http_method":"POST","short_description":"Create an individual contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_id","full_name":"designated_point_of_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_type","full_name":"designated_point_of_contact_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_id","full_name":"referred_by_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_type","full_name":"referred_by_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_profile_picture","full_name":"individual_profile_picture","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_title","full_name":"individual_title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_job_title","full_name":"individual_job_title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_first_name","full_name":"individual_first_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_middle_name","full_name":"individual_middle_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_last_name","full_name":"individual_last_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_suffix","full_name":"individual_suffix","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_tax_identification_number","full_name":"individual_tax_identification_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_gender","full_name":"individual_gender","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emale\u003c/code\u003e, \u003ccode\u003efemale\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_date_of_birth","full_name":"individual_date_of_birth","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_nationality","full_name":"individual_nationality","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_email_addresses_attributes","full_name":"contact_email_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"contact_email_addresses_attributes[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emobile\u003c/code\u003e, \u003ccode\u003eprimary\u003c/code\u003e, \u003ccode\u003esecondary\u003c/code\u003e, \u003ccode\u003ework\u003c/code\u003e, \u003ccode\u003ehome\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"contact_email_addresses_attributes[email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"phone_numbers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"phone_numbers[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_numbers[phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_addresses_attributes","full_name":"contact_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"city_id","full_name":"contact_addresses_attributes[city_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"contact_addresses_attributes[phone_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"floor","full_name":"contact_addresses_attributes[floor]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"building_name","full_name":"contact_addresses_attributes[building_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"street_name","full_name":"contact_addresses_attributes[street_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zip_code","full_name":"contact_addresses_attributes[zip_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_maps_url","full_name":"contact_addresses_attributes[google_maps_url]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"kyc_completed","full_name":"kyc_completed","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_notes","full_name":"kyc_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document","full_name":"kyc_document","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_notes","full_name":"extra_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facebook_url","full_name":"facebook_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"twitter_url","full_name":"twitter_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_plus_url","full_name":"google_plus_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linkedin_url","full_name":"linkedin_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"instagram_url","full_name":"instagram_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tiktok_url","full_name":"tiktok_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"youtube_url","full_name":"youtube_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"website_url","full_name":"website_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_url","full_name":"location_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_legal_matter_ids","full_name":"linked_legal_matter_ids","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matter_starting_id","full_name":"legal_matter_starting_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_owners_attributes","full_name":"contact_owners_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"owner_id","full_name":"contact_owners_attributes[owner_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/individual_contacts/update","name":"update","apis":[{"api_url":"/api/v1/contacts/individuals/:id","http_method":"PUT","short_description":"Update an individual contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_id","full_name":"referred_by_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_type","full_name":"referred_by_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_id","full_name":"designated_point_of_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_type","full_name":"designated_point_of_contact_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_profile_picture","full_name":"individual_profile_picture","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_profile_picture_detach","full_name":"individual_profile_picture_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_title","full_name":"individual_title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_job_title","full_name":"individual_job_title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_first_name","full_name":"individual_first_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_middle_name","full_name":"individual_middle_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_last_name","full_name":"individual_last_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_suffix","full_name":"individual_suffix","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_tax_identification_number","full_name":"individual_tax_identification_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_gender","full_name":"individual_gender","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emale\u003c/code\u003e, \u003ccode\u003efemale\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_date_of_birth","full_name":"individual_date_of_birth","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_nationality","full_name":"individual_nationality","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_email_addresses_attributes","full_name":"contact_email_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_email_addresses_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_email_addresses_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"contact_email_addresses_attributes[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emobile\u003c/code\u003e, \u003ccode\u003eprimary\u003c/code\u003e, \u003ccode\u003esecondary\u003c/code\u003e, \u003ccode\u003ework\u003c/code\u003e, \u003ccode\u003ehome\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"contact_email_addresses_attributes[email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"phone_numbers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"phone_numbers[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_numbers[phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_addresses_attributes","full_name":"contact_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_addresses_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_addresses_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"city_id","full_name":"contact_addresses_attributes[city_id]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"contact_addresses_attributes[phone_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"floor","full_name":"contact_addresses_attributes[floor]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"building_name","full_name":"contact_addresses_attributes[building_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"street_name","full_name":"contact_addresses_attributes[street_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zip_code","full_name":"contact_addresses_attributes[zip_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_maps_url","full_name":"contact_addresses_attributes[google_maps_url]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"kyc_completed","full_name":"kyc_completed","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_notes","full_name":"kyc_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document","full_name":"kyc_document","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document_detach","full_name":"kyc_document_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_notes","full_name":"extra_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facebook_url","full_name":"facebook_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"twitter_url","full_name":"twitter_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_plus_url","full_name":"google_plus_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linkedin_url","full_name":"linkedin_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"instagram_url","full_name":"instagram_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tiktok_url","full_name":"tiktok_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"youtube_url","full_name":"youtube_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"website_url","full_name":"website_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_url","full_name":"location_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"item_labels_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"item_labels_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_owners_attributes","full_name":"contact_owners_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_owners_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_owners_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"contact_owners_attributes[owner_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"leads":{"doc_url":"/apipie/1.0/leads","id":"leads","api_url":"/api/v1","name":"Leads","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/leads/index","name":"index","apis":[{"api_url":"/api/v1/leads","http_method":"GET","short_description":"Get all leads for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"won","full_name":"won","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_contact_id","full_name":"individual_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_contact_id","full_name":"all_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_user_id","full_name":"all_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_id","full_name":"section_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"archived_status","full_name":"archived_status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enot_archived\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/leads/create","name":"create","apis":[{"api_url":"/api/v1/leads","http_method":"POST","short_description":"Create a lead","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_contact_id","full_name":"individual_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"\n\u003cp\u003eUser\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"\n\u003cp\u003eCurrency\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_value","full_name":"lead_value","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"probability","full_name":"probability","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expected_close_date","full_name":"expected_close_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"loss_reason","full_name":"loss_reason","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"lead_owners_attributes","full_name":"lead_owners_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"owner_id","full_name":"lead_owners_attributes[owner_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/leads/show","name":"show","apis":[{"api_url":"/api/v1/leads/:id","http_method":"GET","short_description":"Get a lead","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/leads/update","name":"update","apis":[{"api_url":"/api/v1/leads/:id","http_method":"PUT","short_description":"Update a lead","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_order","full_name":"section_stage_order","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_contact_id","full_name":"individual_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"\n\u003cp\u003eUser\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"\n\u003cp\u003eCurrency\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_value","full_name":"lead_value","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"probability","full_name":"probability","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expected_close_date","full_name":"expected_close_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"loss_reason","full_name":"loss_reason","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"item_labels_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"item_labels_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"lead_owners_attributes","full_name":"lead_owners_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"lead_owners_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"lead_owners_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"lead_owners_attributes[owner_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/leads/destroy","name":"destroy","apis":[{"api_url":"/api/v1/leads/:id","http_method":"DELETE","short_description":"Delete a lead","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"legal_matters":{"doc_url":"/apipie/1.0/legal_matters","id":"legal_matters","api_url":"/api/v1","name":"Legal_matters","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/legal_matters/index","name":"index","apis":[{"api_url":"/api/v1/legal_matters","http_method":"GET","short_description":"Get all legal_matters for current company","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eExtra sort methods: recently_used_by_company_user\u003c/p\u003e\n","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outcome","full_name":"outcome","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epositive\u003c/code\u003e, \u003ccode\u003enegative\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_id","full_name":"court_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"point_of_contact_id","full_name":"point_of_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"specialization_id","full_name":"specialization_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sector_id","full_name":"sector_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jurisdiction_id","full_name":"jurisdiction_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_task_id","full_name":"related_to_task_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_contact_id","full_name":"all_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_id","full_name":"section_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"archived_status","full_name":"archived_status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enot_archived\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/legal_matters/create","name":"create","apis":[{"api_url":"/api/v1/legal_matters","http_method":"POST","short_description":"Create a legal_matter","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_id","full_name":"court_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_case_number","full_name":"court_case_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representation_type_id","full_name":"representation_type_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"point_of_contact_id","full_name":"point_of_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"specialization_id","full_name":"specialization_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sector_id","full_name":"sector_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jurisdiction_id","full_name":"jurisdiction_id","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region","full_name":"region","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"case_managers","full_name":"case_managers","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"case_managers[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"case_managers[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"personnels","full_name":"personnels","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"personnels[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"personnels[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"estimated_duration","full_name":"estimated_duration","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hearing_starting_id","full_name":"hearing_starting_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_created_at","full_name":"custom_created_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/legal_matters/show","name":"show","apis":[{"api_url":"/api/v1/legal_matters/:id","http_method":"GET","short_description":"Get a legal_matter","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/legal_matters/update","name":"update","apis":[{"api_url":"/api/v1/legal_matters/:id","http_method":"PUT","short_description":"Update a legal_matter","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_order","full_name":"section_stage_order","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_id","full_name":"court_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_case_number","full_name":"court_case_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representation_type_id","full_name":"representation_type_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"point_of_contact_id","full_name":"point_of_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"\n\u003cp\u003eContact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"specialization_id","full_name":"specialization_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sector_id","full_name":"sector_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eCompanyConfiguration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jurisdiction_id","full_name":"jurisdiction_id","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region","full_name":"region","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"case_managers","full_name":"case_managers","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"case_managers[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"case_managers[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"personnels","full_name":"personnels","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"personnels[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"personnels[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"outcome","full_name":"outcome","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epositive\u003c/code\u003e, \u003ccode\u003enegative\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"estimated_duration","full_name":"estimated_duration","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_created_at","full_name":"custom_created_at","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/legal_matters/destroy","name":"destroy","apis":[{"api_url":"/api/v1/legal_matters/:id","http_method":"DELETE","short_description":"Delete a legal_matter","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"milestones":{"doc_url":"/apipie/1.0/milestones","id":"milestones","api_url":"/api/v1","name":"Milestones","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/milestones/index","name":"index","apis":[{"api_url":"/api/v1/milestones","http_method":"GET","short_description":"Get all milestones for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/milestones/create","name":"create","apis":[{"api_url":"/api/v1/milestones","http_method":"POST","short_description":"Create a milestone","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"related_to_type","full_name":"related_to_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fees_amount","full_name":"fees_amount","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fees_currency_id","full_name":"fees_currency_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expenses_amount","full_name":"expenses_amount","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expenses_currency_id","full_name":"expenses_currency_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"milestone_assignees_attributes","full_name":"milestone_assignees_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"assigned_to_id","full_name":"milestone_assignees_attributes[assigned_to_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"milestone_assignees_attributes[assigned_to_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/milestones/show","name":"show","apis":[{"api_url":"/api/v1/milestones/:id","http_method":"GET","short_description":"Get a milestone","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/milestones/update","name":"update","apis":[{"api_url":"/api/v1/milestones/:id","http_method":"PUT","short_description":"Update a milestone","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fees_amount","full_name":"fees_amount","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fees_currency_id","full_name":"fees_currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expenses_amount","full_name":"expenses_amount","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expenses_currency_id","full_name":"expenses_currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"milestone_assignees_attributes","full_name":"milestone_assignees_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"milestone_assignees_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"milestone_assignees_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"milestone_assignees_attributes[assigned_to_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"milestone_assignees_attributes[assigned_to_type]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/milestones/destroy","name":"destroy","apis":[{"api_url":"/api/v1/milestones/:id","http_method":"DELETE","short_description":"Delete a milestone","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"oauth":{"doc_url":"/apipie/1.0/oauth","id":"oauth","api_url":"/api/v1","name":"Oauth","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/oauth/initiate","name":"initiate","apis":[{"api_url":"/api/v1/authentication/oauth/:provider","http_method":"GET","short_description":"Initiate OAuth login flow","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"provider","full_name":"provider","description":"\n\u003cp\u003eOAuth provider (google or microsoft)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003egoogle\u003c/code\u003e, \u003ccode\u003emicrosoft\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/oauth/callback","name":"callback","apis":[{"api_url":"/api/v1/authentication/oauth/:provider/callback","http_method":"GET","short_description":"OAuth callback endpoint","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"provider","full_name":"provider","description":"\n\u003cp\u003eOAuth provider (google or microsoft)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003egoogle\u003c/code\u003e, \u003ccode\u003emicrosoft\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n\u003cp\u003eAuthorization code from provider\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state","full_name":"state","description":"\n\u003cp\u003eCSRF state parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"organization_contacts":{"doc_url":"/apipie/1.0/organization_contacts","id":"organization_contacts","api_url":"/api/v1","name":"Organization_contacts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/organization_contacts/create","name":"create","apis":[{"api_url":"/api/v1/contacts/organizations","http_method":"POST","short_description":"Create an organization contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_id","full_name":"designated_point_of_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_type","full_name":"designated_point_of_contact_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_id","full_name":"referred_by_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_type","full_name":"referred_by_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_logo","full_name":"organization_logo","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_name","full_name":"organization_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_type_id","full_name":"organization_type_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_industry_id","full_name":"organization_industry_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_about","full_name":"organization_about","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_tax_identification_number","full_name":"organization_tax_identification_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_date_of_foundation","full_name":"organization_date_of_foundation","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_jurisdiction_of_incorporation","full_name":"organization_jurisdiction_of_incorporation","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_registration_number","full_name":"organization_registration_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_owner_email","full_name":"organization_owner_email","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_email_addresses_attributes","full_name":"contact_email_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"contact_email_addresses_attributes[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emobile\u003c/code\u003e, \u003ccode\u003eprimary\u003c/code\u003e, \u003ccode\u003esecondary\u003c/code\u003e, \u003ccode\u003ework\u003c/code\u003e, \u003ccode\u003ehome\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"contact_email_addresses_attributes[email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"phone_numbers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"phone_numbers[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_numbers[phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_addresses_attributes","full_name":"contact_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"city_id","full_name":"contact_addresses_attributes[city_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"contact_addresses_attributes[phone_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"floor","full_name":"contact_addresses_attributes[floor]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"building_name","full_name":"contact_addresses_attributes[building_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"street_name","full_name":"contact_addresses_attributes[street_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zip_code","full_name":"contact_addresses_attributes[zip_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_maps_url","full_name":"contact_addresses_attributes[google_maps_url]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_bank_accounts_attributes","full_name":"contact_bank_accounts_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"iban","full_name":"contact_bank_accounts_attributes[iban]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"swift_or_bic","full_name":"contact_bank_accounts_attributes[swift_or_bic]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_number","full_name":"contact_bank_accounts_attributes[account_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bank_name","full_name":"contact_bank_accounts_attributes[bank_name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch_name","full_name":"contact_bank_accounts_attributes[branch_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch_address","full_name":"contact_bank_accounts_attributes[branch_address]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch_country","full_name":"contact_bank_accounts_attributes[branch_country]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"routing_number","full_name":"contact_bank_accounts_attributes[routing_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"short_code","full_name":"contact_bank_accounts_attributes[short_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bsb_number","full_name":"contact_bank_accounts_attributes[bsb_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ifcs_code","full_name":"contact_bank_accounts_attributes[ifcs_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transit_number","full_name":"contact_bank_accounts_attributes[transit_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"clabe","full_name":"contact_bank_accounts_attributes[clabe]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_notes","full_name":"contact_bank_accounts_attributes[extra_notes]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"kyc_completed","full_name":"kyc_completed","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_notes","full_name":"kyc_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document","full_name":"kyc_document","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_notes","full_name":"extra_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facebook_url","full_name":"facebook_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"twitter_url","full_name":"twitter_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_plus_url","full_name":"google_plus_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linkedin_url","full_name":"linkedin_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"instagram_url","full_name":"instagram_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tiktok_url","full_name":"tiktok_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"youtube_url","full_name":"youtube_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"website_url","full_name":"website_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_url","full_name":"location_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_legal_matter_ids","full_name":"linked_legal_matter_ids","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matter_starting_id","full_name":"legal_matter_starting_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_owners_attributes","full_name":"contact_owners_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"owner_id","full_name":"contact_owners_attributes[owner_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/organization_contacts/update","name":"update","apis":[{"api_url":"/api/v1/contacts/organizations/:id","http_method":"PUT","short_description":"Update an organization contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_id","full_name":"designated_point_of_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"designated_point_of_contact_type","full_name":"designated_point_of_contact_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_id","full_name":"referred_by_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"referred_by_type","full_name":"referred_by_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contact_id","full_name":"organization_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_logo","full_name":"organization_logo","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_logo_detach","full_name":"organization_logo_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_name","full_name":"organization_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_about","full_name":"organization_about","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_type_id","full_name":"organization_type_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_industry_id","full_name":"organization_industry_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_tax_identification_number","full_name":"organization_tax_identification_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_date_of_foundation","full_name":"organization_date_of_foundation","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_jurisdiction_of_incorporation","full_name":"organization_jurisdiction_of_incorporation","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_registration_number","full_name":"organization_registration_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_owner_email","full_name":"organization_owner_email","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_email_addresses_attributes","full_name":"contact_email_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_email_addresses_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_email_addresses_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"contact_email_addresses_attributes[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emobile\u003c/code\u003e, \u003ccode\u003eprimary\u003c/code\u003e, \u003ccode\u003esecondary\u003c/code\u003e, \u003ccode\u003ework\u003c/code\u003e, \u003ccode\u003ehome\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"contact_email_addresses_attributes[email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"phone_numbers","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"phone_numbers[label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_numbers[phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_addresses_attributes","full_name":"contact_addresses_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_addresses_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_addresses_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"city_id","full_name":"contact_addresses_attributes[city_id]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"contact_addresses_attributes[phone_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"floor","full_name":"contact_addresses_attributes[floor]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"building_name","full_name":"contact_addresses_attributes[building_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"street_name","full_name":"contact_addresses_attributes[street_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zip_code","full_name":"contact_addresses_attributes[zip_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_maps_url","full_name":"contact_addresses_attributes[google_maps_url]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_bank_accounts_attributes","full_name":"contact_bank_accounts_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_bank_accounts_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_bank_accounts_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"iban","full_name":"contact_bank_accounts_attributes[iban]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"swift_or_bic","full_name":"contact_bank_accounts_attributes[swift_or_bic]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_number","full_name":"contact_bank_accounts_attributes[account_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bank_name","full_name":"contact_bank_accounts_attributes[bank_name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch_name","full_name":"contact_bank_accounts_attributes[branch_name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch_address","full_name":"contact_bank_accounts_attributes[branch_address]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch_country","full_name":"contact_bank_accounts_attributes[branch_country]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"routing_number","full_name":"contact_bank_accounts_attributes[routing_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"short_code","full_name":"contact_bank_accounts_attributes[short_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bsb_number","full_name":"contact_bank_accounts_attributes[bsb_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ifcs_code","full_name":"contact_bank_accounts_attributes[ifcs_code]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transit_number","full_name":"contact_bank_accounts_attributes[transit_number]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"clabe","full_name":"contact_bank_accounts_attributes[clabe]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_notes","full_name":"contact_bank_accounts_attributes[extra_notes]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"kyc_completed","full_name":"kyc_completed","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_notes","full_name":"kyc_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document","full_name":"kyc_document","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document_detach","full_name":"kyc_document_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_notes","full_name":"extra_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facebook_url","full_name":"facebook_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"twitter_url","full_name":"twitter_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_plus_url","full_name":"google_plus_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linkedin_url","full_name":"linkedin_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"instagram_url","full_name":"instagram_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tiktok_url","full_name":"tiktok_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"youtube_url","full_name":"youtube_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"website_url","full_name":"website_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_url","full_name":"location_url","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"item_labels_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"item_labels_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_owners_attributes","full_name":"contact_owners_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"contact_owners_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"contact_owners_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"contact_owners_attributes[owner_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"reminders":{"doc_url":"/apipie/1.0/reminders","id":"reminders","api_url":"/api/v1","name":"Reminders","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/reminders/index","name":"index","apis":[{"api_url":"/api/v1/calendar_items/:calendar_item_id/reminders","http_method":"GET","short_description":"Get reminders for a calendar item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"calendar_item_id","full_name":"calendar_item_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/reminders/create","name":"create","apis":[{"api_url":"/api/v1/reminders","http_method":"POST","short_description":"Create a reminder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"related_to_type","full_name":"related_to_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eCalendarItem\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remind_at","full_name":"remind_at","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_audience","full_name":"target_audience","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecreator\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/reminders/show","name":"show","apis":[{"api_url":"/api/v1/reminders/:id","http_method":"GET","short_description":"Get a reminder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/reminders/update","name":"update","apis":[{"api_url":"/api/v1/reminders/:id","http_method":"PUT","short_description":"Update a reminder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remind_at","full_name":"remind_at","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_audience","full_name":"target_audience","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecreator\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/reminders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/reminders/:id","http_method":"DELETE","short_description":"Delete a reminder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"/apipie/1.0/roles","id":"roles","api_url":"/api/v1","name":"Roles","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/roles/index","name":"index","apis":[{"api_url":"/api/v1/roles","http_method":"GET","short_description":"Get all roles for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/roles/create","name":"create","apis":[{"api_url":"/api/v1/roles","http_method":"POST","short_description":"Create a new role","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_permissions_attributes","full_name":"role_permissions_attributes","description":"\n\u003cp\u003eArray of role permissions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"resource_type","full_name":"role_permissions_attributes[resource_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eCompany\u003c/code\u003e, \u003ccode\u003eCompanyUser\u003c/code\u003e, \u003ccode\u003eCompanyConfiguration\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eCurrency\u003c/code\u003e, \u003ccode\u003eSection\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eAnnouncement\u003c/code\u003e, \u003ccode\u003eAutomation\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e, \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::File\u003c/code\u003e, \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eKyc::Document\u003c/code\u003e, \u003ccode\u003eKyc::DocumentTemplate\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e, \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::ChartOfAccount\u003c/code\u003e, \u003ccode\u003eFinancial::JournalEntry\u003c/code\u003e, \u003ccode\u003eFinancial::Budget\u003c/code\u003e, \u003ccode\u003eKpi::Target\u003c/code\u003e, \u003ccode\u003eHr::CompanyPolicy\u003c/code\u003e, \u003ccode\u003eHr::CompanyPolicyCategory\u003c/code\u003e, \u003ccode\u003eHr::PerformanceReview\u003c/code\u003e, \u003ccode\u003eHr::Schedule\u003c/code\u003e, \u003ccode\u003eHr::UserSchedule\u003c/code\u003e, \u003ccode\u003eHr::Holiday\u003c/code\u003e, \u003ccode\u003eHr::LeaveType\u003c/code\u003e, \u003ccode\u003eHr::LeaveBalance\u003c/code\u003e, \u003ccode\u003eHr::LeaveRequest\u003c/code\u003e, \u003ccode\u003eHr::AttendanceRecord\u003c/code\u003e, \u003ccode\u003eHr::UserDailySummary\u003c/code\u003e, \u003ccode\u003eHr::UserPeriodSummary\u003c/code\u003e, \u003ccode\u003eHr::Training\u003c/code\u003e, \u003ccode\u003eHr::UserTraining\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_id","full_name":"role_permissions_attributes[resource_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"actions","full_name":"role_permissions_attributes[actions]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_roles_attributes","full_name":"company_user_roles_attributes","description":"\n\u003cp\u003eArray of company user roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"company_user_id","full_name":"company_user_roles_attributes[company_user_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/roles/show","name":"show","apis":[{"api_url":"/api/v1/roles/:id","http_method":"GET","short_description":"Get a role","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/roles/update","name":"update","apis":[{"api_url":"/api/v1/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_permissions_attributes","full_name":"role_permissions_attributes","description":"\n\u003cp\u003eArray of role permissions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"role_permissions_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"role_permissions_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_type","full_name":"role_permissions_attributes[resource_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eCompany\u003c/code\u003e, \u003ccode\u003eCompanyUser\u003c/code\u003e, \u003ccode\u003eCompanyConfiguration\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eCurrency\u003c/code\u003e, \u003ccode\u003eSection\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eAnnouncement\u003c/code\u003e, \u003ccode\u003eAutomation\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e, \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::File\u003c/code\u003e, \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eKyc::Document\u003c/code\u003e, \u003ccode\u003eKyc::DocumentTemplate\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e, \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::ChartOfAccount\u003c/code\u003e, \u003ccode\u003eFinancial::JournalEntry\u003c/code\u003e, \u003ccode\u003eFinancial::Budget\u003c/code\u003e, \u003ccode\u003eKpi::Target\u003c/code\u003e, \u003ccode\u003eHr::CompanyPolicy\u003c/code\u003e, \u003ccode\u003eHr::CompanyPolicyCategory\u003c/code\u003e, \u003ccode\u003eHr::PerformanceReview\u003c/code\u003e, \u003ccode\u003eHr::Schedule\u003c/code\u003e, \u003ccode\u003eHr::UserSchedule\u003c/code\u003e, \u003ccode\u003eHr::Holiday\u003c/code\u003e, \u003ccode\u003eHr::LeaveType\u003c/code\u003e, \u003ccode\u003eHr::LeaveBalance\u003c/code\u003e, \u003ccode\u003eHr::LeaveRequest\u003c/code\u003e, \u003ccode\u003eHr::AttendanceRecord\u003c/code\u003e, \u003ccode\u003eHr::UserDailySummary\u003c/code\u003e, \u003ccode\u003eHr::UserPeriodSummary\u003c/code\u003e, \u003ccode\u003eHr::Training\u003c/code\u003e, \u003ccode\u003eHr::UserTraining\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_id","full_name":"role_permissions_attributes[resource_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"actions","full_name":"role_permissions_attributes[actions]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_roles_attributes","full_name":"company_user_roles_attributes","description":"\n\u003cp\u003eArray of company user roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"company_user_roles_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"company_user_roles_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_user_id","full_name":"company_user_roles_attributes[company_user_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/roles/destroy","name":"destroy","apis":[{"api_url":"/api/v1/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"search":{"doc_url":"/apipie/1.0/search","id":"search","api_url":"/api/v1","name":"Search","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/search/index","name":"index","apis":[{"api_url":"/api/v1/search","http_method":"GET","short_description":"Global system search","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_of_records","full_name":"number_of_records","description":"\n\u003cp\u003edefault: 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hearings_enabled","full_name":"hearings_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hearings_order_by_column","full_name":"hearings_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003erecently_used_by_company_user\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hearings_order_by_direction","full_name":"hearings_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matters_enabled","full_name":"legal_matters_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matters_order_by_column","full_name":"legal_matters_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003erecently_used_by_company_user\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matters_order_by_direction","full_name":"legal_matters_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teams_enabled","full_name":"teams_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teams_order_by_column","full_name":"teams_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teams_order_by_direction","full_name":"teams_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"users_enabled","full_name":"users_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"users_order_by_column","full_name":"users_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003efirst_name\u003c/code\u003e, \u003ccode\u003elast_name\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"users_order_by_direction","full_name":"users_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contacts_enabled","full_name":"contacts_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contacts_order_by_column","full_name":"contacts_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contacts_order_by_direction","full_name":"contacts_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_contacts_enabled","full_name":"individual_contacts_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_contacts_order_by_column","full_name":"individual_contacts_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eindividual_first_name\u003c/code\u003e, \u003ccode\u003eindividual_last_name\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"individual_contacts_order_by_direction","full_name":"individual_contacts_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contacts_enabled","full_name":"organization_contacts_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contacts_order_by_column","full_name":"organization_contacts_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eorganization_name\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_contacts_order_by_direction","full_name":"organization_contacts_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tasks_enabled","full_name":"tasks_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tasks_order_by_column","full_name":"tasks_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003erecently_used_by_company_user\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tasks_order_by_direction","full_name":"tasks_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calendar_items_enabled","full_name":"calendar_items_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calendar_items_order_by_column","full_name":"calendar_items_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003estart_time\u003c/code\u003e, \u003ccode\u003eend_time\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calendar_items_order_by_direction","full_name":"calendar_items_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_invoices_enabled","full_name":"financial_invoices_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_invoices_order_by_column","full_name":"financial_invoices_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecustomer_name\u003c/code\u003e, \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003epayment_due_date\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_invoices_order_by_direction","full_name":"financial_invoices_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_expenses_enabled","full_name":"financial_expenses_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_expenses_order_by_column","full_name":"financial_expenses_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003edue_date\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_expenses_order_by_direction","full_name":"financial_expenses_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document_templates_enabled","full_name":"kyc_document_templates_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document_templates_order_by_column","full_name":"kyc_document_templates_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kyc_document_templates_order_by_direction","full_name":"kyc_document_templates_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_enabled","full_name":"leads_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_order_by_column","full_name":"leads_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_order_by_direction","full_name":"leads_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_files_enabled","full_name":"storage_files_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_files_order_by_column","full_name":"storage_files_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_files_order_by_direction","full_name":"storage_files_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_accounts_enabled","full_name":"chart_of_accounts_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_accounts_order_by_column","full_name":"chart_of_accounts_order_by_column","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_accounts_order_by_direction","full_name":"chart_of_accounts_order_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sharepoint_enabled","full_name":"sharepoint_enabled","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"search_histories":{"doc_url":"/apipie/1.0/search_histories","id":"search_histories","api_url":"/api/v1","name":"Search_histories","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/search_histories/index","name":"index","apis":[{"api_url":"/api/v1/search_histories","http_method":"GET","short_description":"Get search history for current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/search_histories/create","name":"create","apis":[{"api_url":"/api/v1/search_histories","http_method":"POST","short_description":"Record a search history entry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"searchable_type","full_name":"searchable_type","description":"\n\u003cp\u003eType of the searchable record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"searchable_id","full_name":"searchable_id","description":"\n\u003cp\u003eID of the searchable record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/search_histories/destroy","name":"destroy","apis":[{"api_url":"/api/v1/search_histories/:id","http_method":"DELETE","short_description":"Delete a search history entry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/search_histories/destroy_all","name":"destroy_all","apis":[{"api_url":"/api/v1/search_histories","http_method":"DELETE","short_description":"Clear all search history for current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"section_stage_items":{"doc_url":"/apipie/1.0/section_stage_items","id":"section_stage_items","api_url":"/api/v1","name":"Section_stage_items","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/section_stage_items/index","name":"index","apis":[{"api_url":"/api/v1/sections/:section_id/stages/:stage_id/items","http_method":"GET","short_description":"Get a stage's items","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"section_id","full_name":"section_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stage_id","full_name":"stage_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"section_stages":{"doc_url":"/apipie/1.0/section_stages","id":"section_stages","api_url":"/api/v1","name":"Section_stages","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/section_stages/index","name":"index","apis":[{"api_url":"/api/v1/sections/:section_id/stages","http_method":"GET","short_description":"Get all stages for a section","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_id","full_name":"section_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/section_stages/create","name":"create","apis":[{"api_url":"/api/v1/sections/:section_id/stages","http_method":"POST","short_description":"Create a new stage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"form_columns","full_name":"form_columns","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"index","full_name":"form_columns[index]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"form_columns[columns]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"form_columns[columns][name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"form_columns[columns][required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/section_stages/show","name":"show","apis":[{"api_url":"/api/v1/sections/:section_id/stages/:id","http_method":"GET","short_description":"Get a stage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_id","full_name":"section_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/section_stages/update","name":"update","apis":[{"api_url":"/api/v1/sections/:section_id/stages/:id","http_method":"PUT","short_description":"Update a stage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_id","full_name":"section_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"form_columns","full_name":"form_columns","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"index","full_name":"form_columns[index]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"form_columns[columns]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"form_columns[columns][name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"form_columns[columns][required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/section_stages/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sections/:section_id/stages/:id","http_method":"DELETE","short_description":"Delete a stage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_id","full_name":"section_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"sections":{"doc_url":"/apipie/1.0/sections","id":"sections","api_url":"/api/v1","name":"Sections","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/sections/index","name":"index","apis":[{"api_url":"/api/v1/sections","http_method":"GET","short_description":"Get all sections for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_type","full_name":"section_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003econtacts\u003c/code\u003e, \u003ccode\u003etasks\u003c/code\u003e, \u003ccode\u003elegal_matters\u003c/code\u003e, \u003ccode\u003eleads\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/sections/create","name":"create","apis":[{"api_url":"/api/v1/sections","http_method":"POST","short_description":"Create a new section","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_type","full_name":"section_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econtacts\u003c/code\u003e, \u003ccode\u003etasks\u003c/code\u003e, \u003ccode\u003elegal_matters\u003c/code\u003e, \u003ccode\u003eleads\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"allow_multiple_stages_per_item","full_name":"allow_multiple_stages_per_item","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"table_columns","full_name":"table_columns","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"key","full_name":"table_columns[key]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"table_columns[title]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"form_columns","full_name":"form_columns","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"index","full_name":"form_columns[index]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"form_columns[columns]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"form_columns[columns][name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"form_columns[columns][required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}]},{"name":"listing_filters","full_name":"listing_filters","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_folders_on_item_create","full_name":"default_folders_on_item_create","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/sections/show","name":"show","apis":[{"api_url":"/api/v1/sections/:id","http_method":"GET","short_description":"Get a section","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/sections/update","name":"update","apis":[{"api_url":"/api/v1/sections/:id","http_method":"PUT","short_description":"Update a section","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"allow_multiple_stages_per_item","full_name":"allow_multiple_stages_per_item","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_folders_on_item_create","full_name":"default_folders_on_item_create","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"table_columns","full_name":"table_columns","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"key","full_name":"table_columns[key]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"table_columns[title]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"form_columns","full_name":"form_columns","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"index","full_name":"form_columns[index]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"form_columns[columns]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"form_columns[columns][name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"form_columns[columns][required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}]},{"name":"listing_filters","full_name":"listing_filters","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/sections/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sections/:id","http_method":"DELETE","short_description":"Delete a section","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"states":{"doc_url":"/apipie/1.0/states","id":"states","api_url":"/api/v1","name":"States","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/states/by_country","name":"by_country","apis":[{"api_url":"/api/v1/states/by_country/:country_id","http_method":"GET","short_description":"List states by country","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"country_id","full_name":"country_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"subscriptions":{"doc_url":"/apipie/1.0/subscriptions","id":"subscriptions","api_url":"/api/v1","name":"Subscriptions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/subscriptions/plans","name":"plans","apis":[{"api_url":"/api/v1/subscriptions/plans","http_method":"GET","short_description":"Get all subscription plans","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"task_relationships":{"doc_url":"/apipie/1.0/task_relationships","id":"task_relationships","api_url":"/api/v1","name":"Task_relationships","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/task_relationships/all","name":"all","apis":[{"api_url":"/api/v1/tasks/relationships","http_method":"GET","short_description":"Get all task relatinoships for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"task_id","full_name":"task_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/task_relationships/index","name":"index","apis":[{"api_url":"/api/v1/tasks/:task_id/relationships","http_method":"GET","short_description":"Get task relationships of a specific task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"task_id","full_name":"task_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/task_relationships/create","name":"create","apis":[{"api_url":"/api/v1/tasks/relationships","http_method":"POST","short_description":"Create a task relationship","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"items","full_name":"items","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"task_id","full_name":"items[task_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"items[related_to_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"items[related_to_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/task_relationships/destroy","name":"destroy","apis":[{"api_url":"/api/v1/tasks/:task_id/relationships/:id","http_method":"DELETE","short_description":"Delete a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"task_id","full_name":"task_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"tasks":{"doc_url":"/apipie/1.0/tasks","id":"tasks","api_url":"/api/v1","name":"Tasks","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/tasks/index","name":"index","apis":[{"api_url":"/api/v1/tasks","http_method":"GET","short_description":"Get all tasks for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_contact_id","full_name":"related_to_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_user_id","full_name":"all_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_id","full_name":"section_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"archived_status","full_name":"archived_status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enot_archived\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/tasks/create","name":"create","apis":[{"api_url":"/api/v1/tasks","http_method":"POST","short_description":"Create a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority_id","full_name":"priority_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"location","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget","full_name":"budget","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable","full_name":"billable","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hourly_rate","full_name":"hourly_rate","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"estimated_duration","full_name":"estimated_duration","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"task_relationships_attributes","full_name":"task_relationships_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"related_to_type","full_name":"task_relationships_attributes[related_to_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"task_relationships_attributes[related_to_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"task_assignees_attributes","full_name":"task_assignees_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"assigned_to_type","full_name":"task_assignees_attributes[assigned_to_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"task_assignees_attributes[assigned_to_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/tasks/show","name":"show","apis":[{"api_url":"/api/v1/tasks/:id","http_method":"GET","short_description":"Get a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/tasks/update","name":"update","apis":[{"api_url":"/api/v1/tasks/:id","http_method":"PUT","short_description":"Update a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_id","full_name":"section_stage_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"section_stage_order","full_name":"section_stage_order","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority_id","full_name":"priority_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"location","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget","full_name":"budget","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable","full_name":"billable","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hourly_rate","full_name":"hourly_rate","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"estimated_duration","full_name":"estimated_duration","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"task_assignees_attributes","full_name":"task_assignees_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"task_assignees_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"task_assignees_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"task_assignees_attributes[assigned_to_type]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"task_assignees_attributes[assigned_to_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"item_labels_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"item_labels_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"task_relationships_attributes","full_name":"task_relationships_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"task_relationships_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"task_relationships_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"task_relationships_attributes[related_to_type]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLead\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"task_relationships_attributes[related_to_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/tasks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/tasks/:id","http_method":"DELETE","short_description":"Delete a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"user_devices":{"doc_url":"/apipie/1.0/user_devices","id":"user_devices","api_url":"/api/v1","name":"User_devices","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/user_devices/create","name":"create","apis":[{"api_url":"/api/v1/user_devices","http_method":"POST","short_description":"Create or update user device","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"imei","full_name":"imei","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"brand","full_name":"brand","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_version","full_name":"os_version","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"device_token","full_name":"device_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"app_version","full_name":"app_version","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/user_devices/destroy","name":"destroy","apis":[{"api_url":"/api/v1/user_devices/:imei","http_method":"DELETE","short_description":"Delete user device","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"imei","full_name":"imei","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"user_sessions":{"doc_url":"/apipie/1.0/user_sessions","id":"user_sessions","api_url":"/api/v1","name":"User_sessions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/user_sessions/index","name":"index","apis":[{"api_url":"/api/v1/user_sessions","http_method":"GET","short_description":"List all active sessions for the current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/user_sessions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/user_sessions/:id","http_method":"DELETE","short_description":"Revoke a specific session (force logout device)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSession ID to revoke\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/user_sessions/revoke_others","name":"revoke_others","apis":[{"api_url":"/api/v1/user_sessions/revoke_others","http_method":"DELETE","short_description":"Revoke all sessions except the current one","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/user_sessions/revoke_all","name":"revoke_all","apis":[{"api_url":"/api/v1/user_sessions/revoke_all","http_method":"DELETE","short_description":"Revoke all sessions (force logout everywhere)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"/apipie/1.0/users","id":"users","api_url":"/api/v1","name":"Users","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/users/show","name":"show","apis":[{"api_url":"/api/v1/users","http_method":"GET","short_description":"Get your current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/users/update","name":"update","apis":[{"api_url":"/api/v1/users","http_method":"PUT","short_description":"Update your current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"title","full_name":"title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"middle_name","full_name":"middle_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"avatar","full_name":"avatar","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"avatar_detach","full_name":"avatar_detach","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"completed_sign_up_process","full_name":"completed_sign_up_process","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timezone","full_name":"timezone","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_password","full_name":"new_password","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_password_confirmation","full_name":"new_password_confirmation","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_password","full_name":"current_password","description":"\n\u003cp\u003eCurrent password (required only when changing password and user has previously set a password)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"versions":{"doc_url":"/apipie/1.0/versions","id":"versions","api_url":"/api/v1","name":"Versions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/versions/index","name":"index","apis":[{"api_url":"/api/v1/versions","http_method":"GET","short_description":"Get versions of a specific object","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"object_type","full_name":"object_type","description":"\n\u003cp\u003eType of object to get versions for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAutomation::Automation\u003c/code\u003e, \u003ccode\u003eFinancial::Budget\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e, \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::JournalEntry\u003c/code\u003e, \u003ccode\u003eFinancial::Receipt\u003c/code\u003e, \u003ccode\u003eHr::CompanyPolicy\u003c/code\u003e, \u003ccode\u003eCompanyUser\u003c/code\u003e, \u003ccode\u003eCompanyUserPermission\u003c/code\u003e, \u003ccode\u003eCompanyUserRole\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eLegalMatterUser\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eRolePermission\u003c/code\u003e, \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eTeamParticipant\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"object_id","full_name":"object_id","description":"\n\u003cp\u003eID of object to get versions for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Automation::Automations":{"doc_url":"/apipie/1.0/Automation::Automations","id":"Automation::Automations","api_url":"/api/v1","name":"Automation::Automations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Automation::Automations/index","name":"index","apis":[{"api_url":"/api/v1/automation/automations","http_method":"GET","short_description":"Get all automations for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eSearch keyword\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eFilter by active status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_class","full_name":"trigger_class","description":"\n\u003cp\u003eFilter by trigger class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_class","full_name":"action_class","description":"\n\u003cp\u003eFilter by action class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Automation::Automations/show","name":"show","apis":[{"api_url":"/api/v1/automation/automations/:id","http_method":"GET","short_description":"Get an automation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Automation::Automations/create","name":"create","apis":[{"api_url":"/api/v1/automation/automations","http_method":"POST","short_description":"Create an automation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the automation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the automation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eWhether the automation is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_class","full_name":"trigger_class","description":"\n\u003cp\u003eTrigger class name (e.g., ‘Automations::Triggers::LegalMatterCreated’)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_class","full_name":"action_class","description":"\n\u003cp\u003eAction class name (e.g., ‘Automations::Actions::CreateTask’)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_minutes","full_name":"delay_minutes","description":"\n\u003cp\u003eDelay in minutes before executing the action\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eSort order for the automation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_params","full_name":"action_params","description":"\n\u003cp\u003eParameters for the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Automation::Automations/update","name":"update","apis":[{"api_url":"/api/v1/automation/automations/:id","http_method":"PUT","short_description":"Update an automation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the automation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the automation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eWhether the automation is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_class","full_name":"trigger_class","description":"\n\u003cp\u003eTrigger class name (e.g., ‘Automations::Triggers::LegalMatterCreated’)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_class","full_name":"action_class","description":"\n\u003cp\u003eAction class name (e.g., ‘Automations::Actions::CreateTask’)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_minutes","full_name":"delay_minutes","description":"\n\u003cp\u003eDelay in minutes before executing the action\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eSort order for the automation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_params","full_name":"action_params","description":"\n\u003cp\u003eParameters for the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Automation::Automations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/automation/automations/:id","http_method":"DELETE","short_description":"Delete an automation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"available_actions":{"doc_url":"/apipie/1.0/available_actions","id":"available_actions","api_url":"/api/v1","name":"Available_actions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/available_actions/index","name":"index","apis":[{"api_url":"/api/v1/automation/available_actions","http_method":"GET","short_description":"Get all available automation actions","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"available_triggers":{"doc_url":"/apipie/1.0/available_triggers","id":"available_triggers","api_url":"/api/v1","name":"Available_triggers","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/available_triggers/index","name":"index","apis":[{"api_url":"/api/v1/automation/available_triggers","http_method":"GET","short_description":"Get all available automation triggers","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Automation::Runs":{"doc_url":"/apipie/1.0/Automation::Runs","id":"Automation::Runs","api_url":"/api/v1","name":"Automation::Runs","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Automation::Runs/index","name":"index","apis":[{"api_url":"/api/v1/automation/runs","http_method":"GET","short_description":"Get all automation runs for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"automation_id","full_name":"automation_id","description":"\n\u003cp\u003eFilter by automation ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by status (pending, running, completed, failed)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_object_type","full_name":"trigger_object_type","description":"\n\u003cp\u003eFilter by trigger object type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_object_id","full_name":"trigger_object_id","description":"\n\u003cp\u003eFilter by trigger object ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Automation::Runs/show","name":"show","apis":[{"api_url":"/api/v1/automation/runs/:id","http_method":"GET","short_description":"Get an automation run","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"invoiceable":{"doc_url":"/apipie/1.0/invoiceable","id":"invoiceable","api_url":"/api/v1","name":"Invoiceable","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/invoiceable/index","name":"index","apis":[{"api_url":"/api/v1/calendar_items/invoiceable","http_method":"GET","short_description":"Get invoiceable calendar items for specific filters","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"linked_item_type","full_name":"linked_item_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_id","full_name":"linked_item_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_contact_id","full_name":"related_to_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Chat::Conversations":{"doc_url":"/apipie/1.0/Chat::Conversations","id":"Chat::Conversations","api_url":"/api/v1","name":"Chat::Conversations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Chat::Conversations/index","name":"index","apis":[{"api_url":"/api/v1/chat/conversations","http_method":"GET","short_description":"Get all chat conversations","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"conversation_type","full_name":"conversation_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edirect_message\u003c/code\u003e, \u003ccode\u003egroup_chat\u003c/code\u003e, \u003ccode\u003etask_chat\u003c/code\u003e, \u003ccode\u003elegal_matter_chat\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Conversations/create","name":"create","apis":[{"api_url":"/api/v1/chat/conversations","http_method":"POST","short_description":"Create a new chat conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_type","full_name":"conversation_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edirect_message\u003c/code\u003e, \u003ccode\u003egroup_chat\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eTitle of the conversation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user to create a direct message with\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"participant_ids","full_name":"participant_ids","description":"\n\u003cp\u003eIDs of additional participants to add to the conversation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Conversations/show","name":"show","apis":[{"api_url":"/api/v1/chat/conversations/:id","http_method":"GET","short_description":"Get a specific chat conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Conversations/update","name":"update","apis":[{"api_url":"/api/v1/chat/conversations/:id","http_method":"PUT","short_description":"Update a specific chat conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eTitle of the conversation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Chat::Messages":{"doc_url":"/apipie/1.0/Chat::Messages","id":"Chat::Messages","api_url":"/api/v1","name":"Chat::Messages","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Chat::Messages/index","name":"index","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages","http_method":"GET","short_description":"Get messages for a conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"conversation_id","full_name":"conversation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Messages/show","name":"show","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages/:id","http_method":"GET","short_description":"Get a specific message","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Messages/create","name":"create","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages","http_method":"POST","short_description":"Create a new message","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eMessage content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"previews","full_name":"previews","description":"\n\u003cp\u003eArray of object references (e.g., [‘task#1’, ‘document#2’])\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"files","full_name":"files","description":"\n\u003cp\u003eArray of file attachments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Messages/update","name":"update","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages/:id","http_method":"PUT","short_description":"Update a message","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eUpdated message content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"previews","full_name":"previews","description":"\n\u003cp\u003eUpdated array of object references\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Messages/destroy","name":"destroy","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages/:id","http_method":"DELETE","short_description":"Soft delete a message","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Client::CalendarItems":{"doc_url":"/apipie/1.0/Client::CalendarItems","id":"Client::CalendarItems","api_url":"/api/v1","name":"Client::CalendarItems","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Client::CalendarItems/index","name":"index","apis":[{"api_url":"/api/v1/client/calendar_items","http_method":"GET","short_description":"Get all client calendar items","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_after","full_name":"start_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_before","full_name":"start_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_after","full_name":"end_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_before","full_name":"end_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_limit","full_name":"skip_limit","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_type_id","full_name":"item_type_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_type","full_name":"linked_item_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_item_id","full_name":"linked_item_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_user","full_name":"with_user","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Client::CalendarItems/show","name":"show","apis":[{"api_url":"/api/v1/client/calendar_items/:id","http_method":"GET","short_description":"Get a calendar item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_user","full_name":"with_user","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Client::Companies":{"doc_url":"/apipie/1.0/Client::Companies","id":"Client::Companies","api_url":"/api/v1","name":"Client::Companies","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Client::Companies/index","name":"index","apis":[{"api_url":"/api/v1/client/companies","http_method":"GET","short_description":"Get all client companies","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_id","full_name":"country_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Client::Companies/show","name":"show","apis":[{"api_url":"/api/v1/client/companies/:id","http_method":"GET","short_description":"Get a company","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"Client::Hearings":{"doc_url":"/apipie/1.0/Client::Hearings","id":"Client::Hearings","api_url":"/api/v1","name":"Client::Hearings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Client::Hearings/index","name":"index","apis":[{"api_url":"/api/v1/client/hearings","http_method":"GET","short_description":"Get all client hearings","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"legal_matter_id","full_name":"legal_matter_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Client::Hearings/show","name":"show","apis":[{"api_url":"/api/v1/client/hearings/:id","http_method":"GET","short_description":"Get a hearing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Client::LegalMatters":{"doc_url":"/apipie/1.0/Client::LegalMatters","id":"Client::LegalMatters","api_url":"/api/v1","name":"Client::LegalMatters","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Client::LegalMatters/index","name":"index","apis":[{"api_url":"/api/v1/client/legal_matters","http_method":"GET","short_description":"Get all client legal_matters","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_id","full_name":"custom_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outcome","full_name":"outcome","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epositive\u003c/code\u003e, \u003ccode\u003enegative\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"court_id","full_name":"court_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"judge_id","full_name":"judge_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"representing_contact_id","full_name":"representing_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"point_of_contact_id","full_name":"point_of_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opponent_contact_id","full_name":"opponent_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_id","full_name":"status_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"specialization_id","full_name":"specialization_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sector_id","full_name":"sector_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jurisdiction_id","full_name":"jurisdiction_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_task_id","full_name":"related_to_task_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"archived","full_name":"archived","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Client::LegalMatters/show","name":"show","apis":[{"api_url":"/api/v1/client/legal_matters/:id","http_method":"GET","short_description":"Get a legal_matter","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"completions":{"doc_url":"/apipie/1.0/completions","id":"completions","api_url":"/api/v1","name":"Completions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/completions/create","name":"create","apis":[{"api_url":"/api/v1/companies/completion","http_method":"POST","short_description":"Complete company creation with user details and optional invitees","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"position","full_name":"user[position]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company","full_name":"company","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"country_id","full_name":"company[country_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"company[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"logo","full_name":"company[logo]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"firm_size","full_name":"company[firm_size]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billing_email","full_name":"company[billing_email]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_addresses","full_name":"company[email_addresses]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"company[email_addresses][label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address","full_name":"company[email_addresses][email_address]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"phone_numbers","full_name":"company[phone_numbers]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"company[phone_numbers][label]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"company[phone_numbers][phone_number]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"tax_identification_number","full_name":"company[tax_identification_number]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_percentage","full_name":"company[tax_percentage]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_for_calendar_view","full_name":"company[permission_for_calendar_view]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eonly_admins\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_for_task_view","full_name":"company[permission_for_task_view]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eonly_assigned\u003c/code\u003e, \u003ccode\u003eeveryone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"invitees","full_name":"invitees","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"invitees[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"invitees[title]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"invitees[first_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"middle_name","full_name":"invitees[middle_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"invitees[last_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"position","full_name":"invitees[position]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"data_initializations":{"doc_url":"/apipie/1.0/data_initializations","id":"data_initializations","api_url":"/api/v1","name":"Data_initializations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/data_initializations/create","name":"create","apis":[{"api_url":"/api/v1/companies/:id/data_initialization","http_method":"POST","short_description":"Initialize default eFirm data for the company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"deletions":{"doc_url":"/apipie/1.0/deletions","id":"deletions","api_url":"/api/v1","name":"Deletions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/deletions/create","name":"create","apis":[{"api_url":"/api/v1/companies/:id/deletion","http_method":"POST","short_description":"Initiate company deletion by generating and sending OTP","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"temporary_data":{"doc_url":"/apipie/1.0/temporary_data","id":"temporary_data","api_url":"/api/v1","name":"Temporary_data","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/temporary_data/create","name":"create","apis":[{"api_url":"/api/v1/companies/:id/temporary_data","http_method":"POST","short_description":"Create temporary data for the company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"online":{"doc_url":"/apipie/1.0/online","id":"online","api_url":"/api/v1","name":"Online","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/online/index","name":"index","apis":[{"api_url":"/api/v1/companies/:id/users/online","http_method":"GET","short_description":"Get online user ids","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"bulk_deletions":{"doc_url":"/apipie/1.0/bulk_deletions","id":"bulk_deletions","api_url":"/api/v1","name":"Bulk_deletions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/bulk_deletions/create","name":"create","apis":[{"api_url":"/api/v1/hr/company_policies/bulk","http_method":"DELETE","short_description":"Bulk delete company policies","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of company policy IDs to delete\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"invitations":{"doc_url":"/apipie/1.0/invitations","id":"invitations","api_url":"/api/v1","name":"Invitations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/invitations/create","name":"create","apis":[{"api_url":"/api/v1/contacts/:contact_id/invitation","http_method":"POST","short_description":"Invite a contact","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"contact_id","full_name":"contact_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_address_id","full_name":"email_address_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"/apipie/1.0/settings","id":"settings","api_url":"/api/v1","name":"Settings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/settings/show","name":"show","apis":[{"api_url":"/api/v1/currencies/settings","http_method":"GET","short_description":"Get currency settings (default currency and all conversion rates)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/settings/update","name":"update","apis":[{"api_url":"/api/v1/currencies/settings","http_method":"PUT","short_description":"Update currency settings (set default and all conversion rates)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"default_currency_id","full_name":"default_currency_id","description":"\n\u003cp\u003eID of the currency to set as default\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"conversions","full_name":"conversions","description":"\n\u003cp\u003eArray of conversion rates for non-default currencies\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"currency_id","full_name":"conversions[currency_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"conversion_rate","full_name":"conversions[conversion_rate]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Financial::Budgets":{"doc_url":"/apipie/1.0/Financial::Budgets","id":"Financial::Budgets","api_url":"/api/v1","name":"Financial::Budgets","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::Budgets/index","name":"index","apis":[{"api_url":"/api/v1/financial/budgets","http_method":"GET","short_description":"List all budgets","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"start_after","full_name":"start_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_before","full_name":"start_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_after","full_name":"end_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_before","full_name":"end_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget_type","full_name":"budget_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emonetary\u003c/code\u003e, \u003ccode\u003ehourly\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget_value","full_name":"budget_value","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_type","full_name":"budgetable_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eFinancial::ChartOfAccount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_id","full_name":"budgetable_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_approved","full_name":"with_approved","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Budgets/create","name":"create","apis":[{"api_url":"/api/v1/financial/budgets","http_method":"POST","short_description":"Create a new budget","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"budget_data","full_name":"budget_data","description":"\n\u003cp\u003eArray of budget data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_date","full_name":"budget_data[start_date]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"budget_data[end_date]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget_type","full_name":"budget_data[budget_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emonetary\u003c/code\u003e, \u003ccode\u003ehourly\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_type","full_name":"budget_data[budgetable_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eFinancial::ChartOfAccount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget_value","full_name":"budget_data[budget_value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_id","full_name":"budget_data[budgetable_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"budget_data[notes]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"budget_data[currency_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Budgets/show","name":"show","apis":[{"api_url":"/api/v1/financial/budgets/:id","http_method":"GET","short_description":"Show a budget","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Budgets/approve","name":"approve","apis":[{"api_url":"/api/v1/financial/budgets/:id/approve","http_method":"POST","short_description":"Approve a budget","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Budgets/update","name":"update","apis":[{"api_url":"/api/v1/financial/budgets/:id","http_method":"PUT","short_description":"Update a budget","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget_type","full_name":"budget_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emonetary\u003c/code\u003e, \u003ccode\u003ehourly\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budget_value","full_name":"budget_value","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_type","full_name":"budgetable_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eFinancial::ChartOfAccount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_id","full_name":"budgetable_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Budgets/destroy","name":"destroy","apis":[{"api_url":"/api/v1/financial/budgets/:id","http_method":"DELETE","short_description":"Delete a budget","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::ChartOfAccounts":{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts","id":"Financial::ChartOfAccounts","api_url":"/api/v1","name":"Financial::ChartOfAccounts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts/index","name":"index","apis":[{"api_url":"/api/v1/financial/chart_of_accounts","http_method":"GET","short_description":"List all chart of accounts","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"account_type","full_name":"account_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easset\u003c/code\u003e, \u003ccode\u003eliability\u003c/code\u003e, \u003ccode\u003eequity\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003econtra_revenue\u003c/code\u003e, \u003ccode\u003eexpense\u003c/code\u003e, \u003ccode\u003eothers\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_category","full_name":"account_category","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecurrent_asset\u003c/code\u003e, \u003ccode\u003enon_current_asset\u003c/code\u003e, \u003ccode\u003eintangible_asset\u003c/code\u003e, \u003ccode\u003eprepaid_expense\u003c/code\u003e, \u003ccode\u003etrust_asset\u003c/code\u003e, \u003ccode\u003einvestment_asset\u003c/code\u003e, \u003ccode\u003eproperty_plant_equipment\u003c/code\u003e, \u003ccode\u003ecurrent_liability\u003c/code\u003e, \u003ccode\u003enon_current_liability\u003c/code\u003e, \u003ccode\u003eprovision\u003c/code\u003e, \u003ccode\u003elong_term_debt\u003c/code\u003e, \u003ccode\u003etrust_liability\u003c/code\u003e, \u003ccode\u003eaccrued_expense\u003c/code\u003e, \u003ccode\u003eshort_term_debt\u003c/code\u003e, \u003ccode\u003epartner_capital\u003c/code\u003e, \u003ccode\u003eretained_earnings\u003c/code\u003e, \u003ccode\u003eprofit_distribution_reserve\u003c/code\u003e, \u003ccode\u003erevaluation_reserve\u003c/code\u003e, \u003ccode\u003eother_comprehensive_income\u003c/code\u003e, \u003ccode\u003egross_revenue\u003c/code\u003e, \u003ccode\u003einterest_income\u003c/code\u003e, \u003ccode\u003eother_income\u003c/code\u003e, \u003ccode\u003elegal_service_income\u003c/code\u003e, \u003ccode\u003eexpense_reimbursement_income\u003c/code\u003e, \u003ccode\u003ediscount\u003c/code\u003e, \u003ccode\u003erefund\u003c/code\u003e, \u003ccode\u003etransaction_charge\u003c/code\u003e, \u003ccode\u003ecost_of_goods_sold\u003c/code\u003e, \u003ccode\u003eoperating_expense\u003c/code\u003e, \u003ccode\u003enon_operating_expense\u003c/code\u003e, \u003ccode\u003edepreciation_amortization\u003c/code\u003e, \u003ccode\u003efinancing_activity\u003c/code\u003e, \u003ccode\u003emarketing_expense\u003c/code\u003e, \u003ccode\u003eadministrative_expense\u003c/code\u003e, \u003ccode\u003etravel_expense\u003c/code\u003e, \u003ccode\u003eprofessional_service_expense\u003c/code\u003e, \u003ccode\u003einsurance_expense\u003c/code\u003e, \u003ccode\u003elegal_expense\u003c/code\u003e, \u003ccode\u003erevenue_tax\u003c/code\u003e, \u003ccode\u003efinance_income\u003c/code\u003e, \u003ccode\u003efinance_cost\u003c/code\u003e, \u003ccode\u003eforeign_exchange_gain\u003c/code\u003e, \u003ccode\u003eforeign_exchange_loss\u003c/code\u003e, \u003ccode\u003emiscellaneous\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_revenue_transactions","full_name":"for_revenue_transactions","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_expense_transactions","full_name":"for_expense_transactions","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_expense_paid_from_transactions","full_name":"for_expense_paid_from_transactions","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_invoice_taxation","full_name":"for_invoice_taxation","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_expense_taxation","full_name":"for_expense_taxation","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_receipt_payment_account","full_name":"for_receipt_payment_account","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"budgetable_accounts","full_name":"budgetable_accounts","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_root_accounts","full_name":"with_root_accounts","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_balances","full_name":"with_balances","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"balance_start_date","full_name":"balance_start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"balance_end_date","full_name":"balance_end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts/tree","name":"tree","apis":[{"api_url":"/api/v1/financial/chart_of_accounts/tree","http_method":"GET","short_description":"List chart of accounts as a tree","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts/create","name":"create","apis":[{"api_url":"/api/v1/financial/chart_of_accounts","http_method":"POST","short_description":"Create a chart of account","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_type","full_name":"account_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easset\u003c/code\u003e, \u003ccode\u003eliability\u003c/code\u003e, \u003ccode\u003eequity\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003econtra_revenue\u003c/code\u003e, \u003ccode\u003eexpense\u003c/code\u003e, \u003ccode\u003eothers\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_category","full_name":"account_category","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecurrent_asset\u003c/code\u003e, \u003ccode\u003enon_current_asset\u003c/code\u003e, \u003ccode\u003eintangible_asset\u003c/code\u003e, \u003ccode\u003eprepaid_expense\u003c/code\u003e, \u003ccode\u003etrust_asset\u003c/code\u003e, \u003ccode\u003einvestment_asset\u003c/code\u003e, \u003ccode\u003eproperty_plant_equipment\u003c/code\u003e, \u003ccode\u003ecurrent_liability\u003c/code\u003e, \u003ccode\u003enon_current_liability\u003c/code\u003e, \u003ccode\u003eprovision\u003c/code\u003e, \u003ccode\u003elong_term_debt\u003c/code\u003e, \u003ccode\u003etrust_liability\u003c/code\u003e, \u003ccode\u003eaccrued_expense\u003c/code\u003e, \u003ccode\u003eshort_term_debt\u003c/code\u003e, \u003ccode\u003epartner_capital\u003c/code\u003e, \u003ccode\u003eretained_earnings\u003c/code\u003e, \u003ccode\u003eprofit_distribution_reserve\u003c/code\u003e, \u003ccode\u003erevaluation_reserve\u003c/code\u003e, \u003ccode\u003eother_comprehensive_income\u003c/code\u003e, \u003ccode\u003egross_revenue\u003c/code\u003e, \u003ccode\u003einterest_income\u003c/code\u003e, \u003ccode\u003eother_income\u003c/code\u003e, \u003ccode\u003elegal_service_income\u003c/code\u003e, \u003ccode\u003eexpense_reimbursement_income\u003c/code\u003e, \u003ccode\u003ediscount\u003c/code\u003e, \u003ccode\u003erefund\u003c/code\u003e, \u003ccode\u003etransaction_charge\u003c/code\u003e, \u003ccode\u003ecost_of_goods_sold\u003c/code\u003e, \u003ccode\u003eoperating_expense\u003c/code\u003e, \u003ccode\u003enon_operating_expense\u003c/code\u003e, \u003ccode\u003edepreciation_amortization\u003c/code\u003e, \u003ccode\u003efinancing_activity\u003c/code\u003e, \u003ccode\u003emarketing_expense\u003c/code\u003e, \u003ccode\u003eadministrative_expense\u003c/code\u003e, \u003ccode\u003etravel_expense\u003c/code\u003e, \u003ccode\u003eprofessional_service_expense\u003c/code\u003e, \u003ccode\u003einsurance_expense\u003c/code\u003e, \u003ccode\u003elegal_expense\u003c/code\u003e, \u003ccode\u003erevenue_tax\u003c/code\u003e, \u003ccode\u003efinance_income\u003c/code\u003e, \u003ccode\u003efinance_cost\u003c/code\u003e, \u003ccode\u003eforeign_exchange_gain\u003c/code\u003e, \u003ccode\u003eforeign_exchange_loss\u003c/code\u003e, \u003ccode\u003emiscellaneous\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts/show","name":"show","apis":[{"api_url":"/api/v1/financial/chart_of_accounts/:id","http_method":"GET","short_description":"Show a chart of account","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts/update","name":"update","apis":[{"api_url":"/api/v1/financial/chart_of_accounts/:id","http_method":"PUT","short_description":"Update a chart of account","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_type","full_name":"account_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easset\u003c/code\u003e, \u003ccode\u003eliability\u003c/code\u003e, \u003ccode\u003eequity\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003econtra_revenue\u003c/code\u003e, \u003ccode\u003eexpense\u003c/code\u003e, \u003ccode\u003eothers\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_category","full_name":"account_category","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecurrent_asset\u003c/code\u003e, \u003ccode\u003enon_current_asset\u003c/code\u003e, \u003ccode\u003eintangible_asset\u003c/code\u003e, \u003ccode\u003eprepaid_expense\u003c/code\u003e, \u003ccode\u003etrust_asset\u003c/code\u003e, \u003ccode\u003einvestment_asset\u003c/code\u003e, \u003ccode\u003eproperty_plant_equipment\u003c/code\u003e, \u003ccode\u003ecurrent_liability\u003c/code\u003e, \u003ccode\u003enon_current_liability\u003c/code\u003e, \u003ccode\u003eprovision\u003c/code\u003e, \u003ccode\u003elong_term_debt\u003c/code\u003e, \u003ccode\u003etrust_liability\u003c/code\u003e, \u003ccode\u003eaccrued_expense\u003c/code\u003e, \u003ccode\u003eshort_term_debt\u003c/code\u003e, \u003ccode\u003epartner_capital\u003c/code\u003e, \u003ccode\u003eretained_earnings\u003c/code\u003e, \u003ccode\u003eprofit_distribution_reserve\u003c/code\u003e, \u003ccode\u003erevaluation_reserve\u003c/code\u003e, \u003ccode\u003eother_comprehensive_income\u003c/code\u003e, \u003ccode\u003egross_revenue\u003c/code\u003e, \u003ccode\u003einterest_income\u003c/code\u003e, \u003ccode\u003eother_income\u003c/code\u003e, \u003ccode\u003elegal_service_income\u003c/code\u003e, \u003ccode\u003eexpense_reimbursement_income\u003c/code\u003e, \u003ccode\u003ediscount\u003c/code\u003e, \u003ccode\u003erefund\u003c/code\u003e, \u003ccode\u003etransaction_charge\u003c/code\u003e, \u003ccode\u003ecost_of_goods_sold\u003c/code\u003e, \u003ccode\u003eoperating_expense\u003c/code\u003e, \u003ccode\u003enon_operating_expense\u003c/code\u003e, \u003ccode\u003edepreciation_amortization\u003c/code\u003e, \u003ccode\u003efinancing_activity\u003c/code\u003e, \u003ccode\u003emarketing_expense\u003c/code\u003e, \u003ccode\u003eadministrative_expense\u003c/code\u003e, \u003ccode\u003etravel_expense\u003c/code\u003e, \u003ccode\u003eprofessional_service_expense\u003c/code\u003e, \u003ccode\u003einsurance_expense\u003c/code\u003e, \u003ccode\u003elegal_expense\u003c/code\u003e, \u003ccode\u003erevenue_tax\u003c/code\u003e, \u003ccode\u003efinance_income\u003c/code\u003e, \u003ccode\u003efinance_cost\u003c/code\u003e, \u003ccode\u003eforeign_exchange_gain\u003c/code\u003e, \u003ccode\u003eforeign_exchange_loss\u003c/code\u003e, \u003ccode\u003emiscellaneous\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::ChartOfAccounts/destroy","name":"destroy","apis":[{"api_url":"/api/v1/financial/chart_of_accounts/:id","http_method":"DELETE","short_description":"Delete a chart of account","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::Expenses":{"doc_url":"/apipie/1.0/Financial::Expenses","id":"Financial::Expenses","api_url":"/api/v1","name":"Financial::Expenses","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::Expenses/index","name":"index","apis":[{"api_url":"/api/v1/financial/expenses","http_method":"GET","short_description":"Get all expenses for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enot_started\u003c/code\u003e, \u003ccode\u003etransferred\u003c/code\u003e, \u003ccode\u003ein_progress\u003c/code\u003e, \u003ccode\u003enot_retained\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billed_to_id","full_name":"billed_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_to_contact_id","full_name":"paid_to_contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_approved","full_name":"with_approved","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_contact_id","full_name":"related_to_contact_id","description":"\n\u003cp\u003eReturn all expenses where (billed to contact_id) or (related to legal matters for contact_id) or (related to hearings for contact_id)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voided","full_name":"voided","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_conversions","full_name":"with_conversions","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Expenses/create","name":"create","apis":[{"api_url":"/api/v1/financial/expenses","http_method":"POST","short_description":"Create a expense","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"billed_to_id","full_name":"billed_to_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_to_contact_id","full_name":"paid_to_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enot_started\u003c/code\u003e, \u003ccode\u003etransferred\u003c/code\u003e, \u003ccode\u003ein_progress\u003c/code\u003e, \u003ccode\u003enot_retained\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unit_price","full_name":"unit_price","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total_amount","full_name":"total_amount","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"declared_amount","full_name":"declared_amount","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total_tax","full_name":"total_tax","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category","full_name":"category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expense_type","full_name":"expense_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"chart_of_account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_from_id","full_name":"paid_from_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_start_date","full_name":"service_start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"service_end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description_line","full_name":"description_line","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_chart_of_account_id","full_name":"tax_chart_of_account_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_by_user_id","full_name":"paid_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Expenses/show","name":"show","apis":[{"api_url":"/api/v1/financial/expenses/:id","http_method":"GET","short_description":"Get a expense","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Expenses/approve","name":"approve","apis":[{"api_url":"/api/v1/financial/expenses/:id/approve","http_method":"POST","short_description":"Approve a expense","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Expenses/update","name":"update","apis":[{"api_url":"/api/v1/financial/expenses/:id","http_method":"PUT","short_description":"Update a expense","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billed_to_id","full_name":"billed_to_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_to_contact_id","full_name":"paid_to_contact_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_type","full_name":"related_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTask\u003c/code\u003e, \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eHearing\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_id","full_name":"related_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enot_started\u003c/code\u003e, \u003ccode\u003etransferred\u003c/code\u003e, \u003ccode\u003ein_progress\u003c/code\u003e, \u003ccode\u003enot_retained\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unit_price","full_name":"unit_price","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total_amount","full_name":"total_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"declared_amount","full_name":"declared_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total_tax","full_name":"total_tax","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category","full_name":"category","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expense_type","full_name":"expense_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"chart_of_account_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_from_id","full_name":"paid_from_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_start_date","full_name":"service_start_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"service_end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description_line","full_name":"description_line","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_chart_of_account_id","full_name":"tax_chart_of_account_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_by_user_id","full_name":"paid_by_user_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Expenses/destroy","name":"destroy","apis":[{"api_url":"/api/v1/financial/expenses/:id","http_method":"DELETE","short_description":"Delete a expense","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::Invoices":{"doc_url":"/apipie/1.0/Financial::Invoices","id":"Financial::Invoices","api_url":"/api/v1","name":"Financial::Invoices","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::Invoices/index","name":"index","apis":[{"api_url":"/api/v1/financial/invoices","http_method":"GET","short_description":"Get all invoices for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003epaid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoiceable_type","full_name":"invoiceable_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoiceable_id","full_name":"invoiceable_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_approved","full_name":"with_approved","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"related_to_contact_id","full_name":"related_to_contact_id","description":"\n\u003cp\u003eReturn all invoices where (invoiceable is contact_id) or (invoiceable is a legal matter for contact_id)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voided","full_name":"voided","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_billing_profile_id","full_name":"company_billing_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/next_invoice_number","name":"next_invoice_number","apis":[{"api_url":"/api/v1/financial/invoices/next_invoice_number","http_method":"GET","short_description":"Get next invoice number for company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/create","name":"create","apis":[{"api_url":"/api/v1/financial/invoices","http_method":"POST","short_description":"Create a invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"invoiceable_type","full_name":"invoiceable_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoiceable_id","full_name":"invoiceable_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_number","full_name":"invoice_number","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003epaid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"customer_name","full_name":"customer_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"customer_email","full_name":"customer_email","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_date","full_name":"invoice_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_due_date","full_name":"payment_due_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"terms_and_conditions_note","full_name":"terms_and_conditions_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_details_note","full_name":"payment_details_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature_note","full_name":"signature_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"general_note","full_name":"general_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_billing_profile_id","full_name":"company_billing_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secondary_currency_id","full_name":"secondary_currency_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type","full_name":"discount_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epercentage\u003c/code\u003e, \u003ccode\u003eamount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type_amount","full_name":"discount_type_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_start_date","full_name":"service_start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"service_end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_items_attributes","full_name":"invoice_items_attributes","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"billable_type","full_name":"invoice_items_attributes[billable_type]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eCalendarItem\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_id","full_name":"invoice_items_attributes[billable_id]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"invoice_items_attributes[description]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"invoice_items_attributes[quantity]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unit_price","full_name":"invoice_items_attributes[unit_price]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_percentage","full_name":"invoice_items_attributes[tax_percentage]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type","full_name":"invoice_items_attributes[discount_type]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epercentage\u003c/code\u003e, \u003ccode\u003eamount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type_amount","full_name":"invoice_items_attributes[discount_type_amount]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"invoice_items_attributes[chart_of_account_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_chart_of_account_id","full_name":"invoice_items_attributes[tax_chart_of_account_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"invoice_tax_items_attributes","full_name":"invoice_tax_items_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"invoice_tax_items_attributes[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_type","full_name":"invoice_tax_items_attributes[tax_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epercentage\u003c/code\u003e, \u003ccode\u003eamount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_type_amount","full_name":"invoice_tax_items_attributes[tax_type_amount]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"invoice_tax_items_attributes[chart_of_account_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/show","name":"show","apis":[{"api_url":"/api/v1/financial/invoices/:id","http_method":"GET","short_description":"Get a invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/by_guid","name":"by_guid","apis":[{"api_url":"/api/v1/financial/invoices/by_guid/:guid","http_method":"GET","short_description":"Get an invoice by guid","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"guid","full_name":"guid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/approve","name":"approve","apis":[{"api_url":"/api/v1/financial/invoices/:id/approve","http_method":"POST","short_description":"Mark invoice as approved","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/update","name":"update","apis":[{"api_url":"/api/v1/financial/invoices/:id","http_method":"PUT","short_description":"Update a invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoiceable_type","full_name":"invoiceable_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoiceable_id","full_name":"invoiceable_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003epaid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"customer_name","full_name":"customer_name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"customer_email","full_name":"customer_email","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_date","full_name":"invoice_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_due_date","full_name":"payment_due_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_billing_profile_id","full_name":"company_billing_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secondary_currency_id","full_name":"secondary_currency_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"terms_and_conditions_note","full_name":"terms_and_conditions_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_details_note","full_name":"payment_details_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature_note","full_name":"signature_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"general_note","full_name":"general_note","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type","full_name":"discount_type","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epercentage\u003c/code\u003e, \u003ccode\u003eamount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type_amount","full_name":"discount_type_amount","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_start_date","full_name":"service_start_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"service_end_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invoice_items_attributes","full_name":"invoice_items_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"invoice_items_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"invoice_items_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_type","full_name":"invoice_items_attributes[billable_type]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eMilestone\u003c/code\u003e, \u003ccode\u003eCalendarItem\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billable_id","full_name":"invoice_items_attributes[billable_id]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"invoice_items_attributes[description]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"invoice_items_attributes[quantity]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unit_price","full_name":"invoice_items_attributes[unit_price]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_percentage","full_name":"invoice_items_attributes[tax_percentage]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type","full_name":"invoice_items_attributes[discount_type]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epercentage\u003c/code\u003e, \u003ccode\u003eamount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discount_type_amount","full_name":"invoice_items_attributes[discount_type_amount]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"invoice_items_attributes[chart_of_account_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_chart_of_account_id","full_name":"invoice_items_attributes[tax_chart_of_account_id]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"invoice_tax_items_attributes","full_name":"invoice_tax_items_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"invoice_tax_items_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"invoice_tax_items_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"invoice_tax_items_attributes[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_type","full_name":"invoice_tax_items_attributes[tax_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epercentage\u003c/code\u003e, \u003ccode\u003eamount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_type_amount","full_name":"invoice_tax_items_attributes[tax_type_amount]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"invoice_tax_items_attributes[chart_of_account_id]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Invoices/destroy","name":"destroy","apis":[{"api_url":"/api/v1/financial/invoices/:id","http_method":"DELETE","short_description":"Delete a invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::JournalEntries":{"doc_url":"/apipie/1.0/Financial::JournalEntries","id":"Financial::JournalEntries","api_url":"/api/v1","name":"Financial::JournalEntries","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::JournalEntries/index","name":"index","apis":[{"api_url":"/api/v1/financial/journal_entries","http_method":"GET","short_description":"List all financial journal entries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"linked_to_id","full_name":"linked_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_to_type","full_name":"linked_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003eapproved\u003c/code\u003e, \u003ccode\u003evoided\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::JournalEntries/create","name":"create","apis":[{"api_url":"/api/v1/financial/journal_entries","http_method":"POST","short_description":"Create a financial journal entry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"memo","full_name":"memo","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"journal_date","full_name":"journal_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_to_id","full_name":"linked_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_to_type","full_name":"linked_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_transactions_attributes","full_name":"financial_transactions_attributes","description":"","required":true,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"debit_amount","full_name":"financial_transactions_attributes[debit_amount]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"credit_amount","full_name":"financial_transactions_attributes[credit_amount]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_start_date","full_name":"financial_transactions_attributes[service_start_date]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"financial_transactions_attributes[service_end_date]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"financial_transactions_attributes[description]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"financial_transactions_attributes[chart_of_account_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"financial_transactions_attributes[title]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::JournalEntries/show","name":"show","apis":[{"api_url":"/api/v1/financial/journal_entries/:id","http_method":"GET","short_description":"Show a financial journal entry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::JournalEntries/approve","name":"approve","apis":[{"api_url":"/api/v1/financial/journal_entries/:id/approve","http_method":"POST","short_description":"Mark journal entry as approved","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::JournalEntries/update","name":"update","apis":[{"api_url":"/api/v1/financial/journal_entries/:id","http_method":"PUT","short_description":"Update a financial journal entry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"memo","full_name":"memo","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"journal_date","full_name":"journal_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_to_id","full_name":"linked_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"linked_to_type","full_name":"linked_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eLegalMatter\u003c/code\u003e, \u003ccode\u003eContact\u003c/code\u003e, \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e, \u003ccode\u003eOrganizationContact\u003c/code\u003e, \u003ccode\u003eIndividualContact\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"financial_transactions_attributes","full_name":"financial_transactions_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"financial_transactions_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"financial_transactions_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"debit_amount","full_name":"financial_transactions_attributes[debit_amount]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"credit_amount","full_name":"financial_transactions_attributes[credit_amount]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_start_date","full_name":"financial_transactions_attributes[service_start_date]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"financial_transactions_attributes[service_end_date]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"financial_transactions_attributes[description]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"financial_transactions_attributes[chart_of_account_id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"financial_transactions_attributes[sort_order]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"financial_transactions_attributes[title]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::JournalEntries/destroy","name":"destroy","apis":[{"api_url":"/api/v1/financial/journal_entries/:id","http_method":"DELETE","short_description":"Delete a financial journal entry","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::Receipts":{"doc_url":"/apipie/1.0/Financial::Receipts","id":"Financial::Receipts","api_url":"/api/v1","name":"Financial::Receipts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::Receipts/index","name":"index","apis":[{"api_url":"/api/v1/financial/receipts","http_method":"GET","short_description":"List all receipts","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"payment_method","full_name":"payment_method","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecash\u003c/code\u003e, \u003ccode\u003ecredit_card\u003c/code\u003e, \u003ccode\u003ebank_transfer\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_date","full_name":"payment_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receiptable_id","full_name":"receiptable_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receiptable_type","full_name":"receiptable_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_account_id","full_name":"payment_account_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003eapproved\u003c/code\u003e, \u003ccode\u003evoided\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Receipts/create","name":"create","apis":[{"api_url":"/api/v1/financial/receipts","http_method":"POST","short_description":"Create a receipt","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"amount","full_name":"amount","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billing_policy","full_name":"billing_policy","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"client_notes","full_name":"client_notes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"internal_notes","full_name":"internal_notes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_date","full_name":"payment_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_method","full_name":"payment_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecash\u003c/code\u003e, \u003ccode\u003ecredit_card\u003c/code\u003e, \u003ccode\u003ebank_transfer\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receiptable_id","full_name":"receiptable_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receiptable_type","full_name":"receiptable_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eFinancial::Invoice\u003c/code\u003e, \u003ccode\u003eFinancial::Expense\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_account_id","full_name":"payment_account_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Receipts/show","name":"show","apis":[{"api_url":"/api/v1/financial/receipts/:id","http_method":"GET","short_description":"Show a receipt","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Receipts/approve","name":"approve","apis":[{"api_url":"/api/v1/financial/receipts/:id/approve","http_method":"POST","short_description":"Mark receipt as approved","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Receipts/update","name":"update","apis":[{"api_url":"/api/v1/financial/receipts/:id","http_method":"PUT","short_description":"Update a receipt","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"amount","full_name":"amount","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"billing_policy","full_name":"billing_policy","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"client_notes","full_name":"client_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"internal_notes","full_name":"internal_notes","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_date","full_name":"payment_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_method","full_name":"payment_method","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecash\u003c/code\u003e, \u003ccode\u003ecredit_card\u003c/code\u003e, \u003ccode\u003ebank_transfer\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_account_id","full_name":"payment_account_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Receipts/destroy","name":"destroy","apis":[{"api_url":"/api/v1/financial/receipts/:id","http_method":"DELETE","short_description":"Delete a receipt","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::Reports":{"doc_url":"/apipie/1.0/Financial::Reports","id":"Financial::Reports","api_url":"/api/v1","name":"Financial::Reports","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::Reports/income_statement","name":"income_statement","apis":[{"api_url":"/api/v1/financial/reports/income_statement","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/aging","name":"aging","apis":[{"api_url":"/api/v1/financial/reports/aging","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of aging report to generate\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ereceivable\u003c/code\u003e, \u003ccode\u003epayable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/aging_contact","name":"aging_contact","apis":[{"api_url":"/api/v1/financial/reports/aging/:type/contact/:contact_id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of aging report: receivables or payables\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ereceivable\u003c/code\u003e, \u003ccode\u003epayable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/client_profitability","name":"client_profitability","apis":[{"api_url":"/api/v1/financial/reports/client_profitability","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/cash_flow","name":"cash_flow","apis":[{"api_url":"/api/v1/financial/reports/cash_flow","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/utilization_rate","name":"utilization_rate","apis":[{"api_url":"/api/v1/financial/reports/utilization_rate","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/time_keeper","name":"time_keeper","apis":[{"api_url":"/api/v1/financial/reports/time_keeper","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/balance_sheet","name":"balance_sheet","apis":[{"api_url":"/api/v1/financial/reports/balance_sheet","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/budget","name":"budget","apis":[{"api_url":"/api/v1/financial/reports/budget","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/trial_balance","name":"trial_balance","apis":[{"api_url":"/api/v1/financial/reports/trial_balance","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Financial::Reports/statement_of_account","name":"statement_of_account","apis":[{"api_url":"/api/v1/financial/reports/statement_of_account/:type/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"type","full_name":"type","description":"\n\u003cp\u003eStatement type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econtact\u003c/code\u003e, \u003ccode\u003eaccount\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eService start date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eService end date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Financial::Transactions":{"doc_url":"/apipie/1.0/Financial::Transactions","id":"Financial::Transactions","api_url":"/api/v1","name":"Financial::Transactions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Financial::Transactions/index","name":"index","apis":[{"api_url":"/api/v1/financial/transactions","http_method":"GET","short_description":"List all transactions","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"service_start_date","full_name":"service_start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_end_date","full_name":"service_end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chart_of_account_id","full_name":"chart_of_account_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_approved","full_name":"with_approved","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::CompanyPolicies":{"doc_url":"/apipie/1.0/Hr::CompanyPolicies","id":"Hr::CompanyPolicies","api_url":"/api/v1","name":"Hr::CompanyPolicies","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::CompanyPolicies/index","name":"index","apis":[{"api_url":"/api/v1/hr/company_policies","http_method":"GET","short_description":"List company policies","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eHr::CompanyPolicyCategory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edraft\u003c/code\u003e, \u003ccode\u003epublished\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicies/show","name":"show","apis":[{"api_url":"/api/v1/hr/company_policies/:id","http_method":"GET","short_description":"Show company policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicies/create","name":"create","apis":[{"api_url":"/api/v1/hr/company_policies","http_method":"POST","short_description":"Create company policy","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"title","full_name":"title","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eHr::CompanyPolicyCategory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edraft\u003c/code\u003e, \u003ccode\u003epublished\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"files","full_name":"files","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicies/update","name":"update","apis":[{"api_url":"/api/v1/hr/company_policies/:id","http_method":"PUT","short_description":"Update company policy","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eHr::CompanyPolicyCategory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edraft\u003c/code\u003e, \u003ccode\u003epublished\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"files","full_name":"files","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_file_ids","full_name":"remove_file_ids","description":"\n\u003cp\u003eIDs of attached files to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicies/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/company_policies/:id","http_method":"DELETE","short_description":"Delete company policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"Hr::CompanyPolicyCategories":{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories","id":"Hr::CompanyPolicyCategories","api_url":"/api/v1","name":"Hr::CompanyPolicyCategories","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories/index","name":"index","apis":[{"api_url":"/api/v1/hr/company_policy_categories","http_method":"GET","short_description":"List company policy categories","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories/show","name":"show","apis":[{"api_url":"/api/v1/hr/company_policy_categories/:id","http_method":"GET","short_description":"Show company policy category","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories/create","name":"create","apis":[{"api_url":"/api/v1/hr/company_policy_categories","http_method":"POST","short_description":"Create company policy category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"icon_name","full_name":"icon_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories/update","name":"update","apis":[{"api_url":"/api/v1/hr/company_policy_categories/:id","http_method":"PUT","short_description":"Update company policy category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"icon_name","full_name":"icon_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/company_policy_categories/:id","http_method":"DELETE","short_description":"Delete company policy category","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"Hr::Holidays":{"doc_url":"/apipie/1.0/Hr::Holidays","id":"Hr::Holidays","api_url":"/api/v1","name":"Hr::Holidays","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Holidays/index","name":"index","apis":[{"api_url":"/api/v1/hr/holidays","http_method":"GET","short_description":"Get all holidays for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eSearch by holiday name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eFilter by year\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Holidays/create","name":"create","apis":[{"api_url":"/api/v1/hr/holidays","http_method":"POST","short_description":"Create a new holiday","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eHoliday name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"\n\u003cp\u003eHoliday date (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Holidays/show","name":"show","apis":[{"api_url":"/api/v1/hr/holidays/:id","http_method":"GET","short_description":"Get a specific holiday","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eHoliday UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Holidays/update","name":"update","apis":[{"api_url":"/api/v1/hr/holidays/:id","http_method":"PUT","short_description":"Update a holiday","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eHoliday UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHoliday name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"\n\u003cp\u003eHoliday date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Holidays/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/holidays/:id","http_method":"DELETE","short_description":"Delete a holiday","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eHoliday UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::LeaveBalances":{"doc_url":"/apipie/1.0/Hr::LeaveBalances","id":"Hr::LeaveBalances","api_url":"/api/v1","name":"Hr::LeaveBalances","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::LeaveBalances/index","name":"index","apis":[{"api_url":"/api/v1/hr/leave_balances","http_method":"GET","short_description":"Get leave balances for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company leave balances (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_leave_type_id","full_name":"hr_leave_type_id","description":"\n\u003cp\u003eFilter by leave type UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eFilter by year\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveBalances/show","name":"show","apis":[{"api_url":"/api/v1/hr/leave_balances/:id","http_method":"GET","short_description":"Get a specific leave balance","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave balance UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::LeaveRequests":{"doc_url":"/apipie/1.0/Hr::LeaveRequests","id":"Hr::LeaveRequests","api_url":"/api/v1","name":"Hr::LeaveRequests","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::LeaveRequests/index","name":"index","apis":[{"api_url":"/api/v1/hr/leave_requests","http_method":"GET","short_description":"Get all leave requests for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_leave_type_id","full_name":"hr_leave_type_id","description":"\n\u003cp\u003eFilter by leave type UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by status (pending, approved, rejected, cancelled)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company leave requests (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveRequests/create","name":"create","apis":[{"api_url":"/api/v1/hr/leave_requests","http_method":"POST","short_description":"Create a new leave request","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_leave_type_id","full_name":"hr_leave_type_id","description":"\n\u003cp\u003eLeave type UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duration_type","full_name":"duration_type","description":"\n\u003cp\u003eDuration type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003efull_day\u003c/code\u003e, \u003ccode\u003efirst_half\u003c/code\u003e, \u003ccode\u003esecond_half\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"reason","description":"\n\u003cp\u003eReason for leave\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveRequests/show","name":"show","apis":[{"api_url":"/api/v1/hr/leave_requests/:id","http_method":"GET","short_description":"Get a specific leave request","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave request UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveRequests/update","name":"update","apis":[{"api_url":"/api/v1/hr/leave_requests/:id","http_method":"PATCH","short_description":"Update a leave request","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave request UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"reason","description":"\n\u003cp\u003eReason for leave\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveRequests/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/leave_requests/:id","http_method":"DELETE","short_description":"Cancel a leave request","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave request UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::LeaveTypes":{"doc_url":"/apipie/1.0/Hr::LeaveTypes","id":"Hr::LeaveTypes","api_url":"/api/v1","name":"Hr::LeaveTypes","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::LeaveTypes/index","name":"index","apis":[{"api_url":"/api/v1/hr/leave_types","http_method":"GET","short_description":"Get all leave types for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eSearch by name or code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eFilter by active status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveTypes/create","name":"create","apis":[{"api_url":"/api/v1/hr/leave_types","http_method":"POST","short_description":"Create a new leave type","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eLeave type name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n\u003cp\u003eLeave type code (unique per company)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"\n\u003cp\u003eColor hex code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_allowance","full_name":"default_allowance","description":"\n\u003cp\u003eDefault annual allowance in days\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_carry_over_days","full_name":"max_carry_over_days","description":"\n\u003cp\u003eMax carry-over days (null = unlimited, 0 = none)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"allow_negative_balance","full_name":"allow_negative_balance","description":"\n\u003cp\u003eAllow negative balance\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prorate_for_new_hires","full_name":"prorate_for_new_hires","description":"\n\u003cp\u003eProrate for new hires\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_paid","full_name":"is_paid","description":"\n\u003cp\u003eWhether leave is paid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eWhether leave type is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveTypes/show","name":"show","apis":[{"api_url":"/api/v1/hr/leave_types/:id","http_method":"GET","short_description":"Get a specific leave type","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave type UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveTypes/update","name":"update","apis":[{"api_url":"/api/v1/hr/leave_types/:id","http_method":"PUT","short_description":"Update a leave type","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave type UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eLeave type name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n\u003cp\u003eLeave type code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"color","description":"\n\u003cp\u003eColor hex code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_allowance","full_name":"default_allowance","description":"\n\u003cp\u003eDefault annual allowance in days\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_carry_over_days","full_name":"max_carry_over_days","description":"\n\u003cp\u003eMax carry-over days\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"allow_negative_balance","full_name":"allow_negative_balance","description":"\n\u003cp\u003eAllow negative balance\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prorate_for_new_hires","full_name":"prorate_for_new_hires","description":"\n\u003cp\u003eProrate for new hires\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_paid","full_name":"is_paid","description":"\n\u003cp\u003eWhether leave is paid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eWhether leave type is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::LeaveTypes/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/leave_types/:id","http_method":"DELETE","short_description":"Delete a leave type","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLeave type UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::PerformanceReviews":{"doc_url":"/apipie/1.0/Hr::PerformanceReviews","id":"Hr::PerformanceReviews","api_url":"/api/v1","name":"Hr::PerformanceReviews","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::PerformanceReviews/index","name":"index","apis":[{"api_url":"/api/v1/hr/performance_reviews","http_method":"GET","short_description":"Get all performance reviews for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reviewer_id","full_name":"reviewer_id","description":"\n\u003cp\u003eFilter by reviewer UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"review_year","full_name":"review_year","description":"\n\u003cp\u003eFilter by year\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"review_quarter","full_name":"review_quarter","description":"\n\u003cp\u003eFilter by quarter (1-4)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"review_type","full_name":"review_type","description":"\n\u003cp\u003eFilter by review type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003equarterly\u003c/code\u003e, \u003ccode\u003eannual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003escheduled\u003c/code\u003e, \u003ccode\u003ein_progress\u003c/code\u003e, \u003ccode\u003ecompleted\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::PerformanceReviews/create","name":"create","apis":[{"api_url":"/api/v1/hr/performance_reviews","http_method":"POST","short_description":"Create a new performance review","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee being evaluated (reviewee)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reviewer_id","full_name":"reviewer_id","description":"\n\u003cp\u003eReviewer (manager/HR conducting the review)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"review_type","full_name":"review_type","description":"\n\u003cp\u003eReview type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003equarterly\u003c/code\u003e, \u003ccode\u003eannual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"review_year","full_name":"review_year","description":"\n\u003cp\u003eReview year (e.g., 2024)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"review_quarter","full_name":"review_quarter","description":"\n\u003cp\u003eReview quarter (1-4, only for quarterly reviews)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_date","full_name":"scheduled_date","description":"\n\u003cp\u003eScheduled review date (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"overall_score","full_name":"overall_score","description":"\n\u003cp\u003eOverall score (1-5 scale)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reviewer_feedback","full_name":"reviewer_feedback","description":"\n\u003cp\u003eReviewer feedback/comments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"career_progression_notes","full_name":"career_progression_notes","description":"\n\u003cp\u003eCareer progression notes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eReview status (default: scheduled)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003escheduled\u003c/code\u003e, \u003ccode\u003ein_progress\u003c/code\u003e, \u003ccode\u003ecompleted\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::PerformanceReviews/show","name":"show","apis":[{"api_url":"/api/v1/hr/performance_reviews/:id","http_method":"GET","short_description":"Get a specific performance review","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePerformance review UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::PerformanceReviews/update","name":"update","apis":[{"api_url":"/api/v1/hr/performance_reviews/:id","http_method":"PUT","short_description":"Update a performance review","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePerformance review UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reviewer_id","full_name":"reviewer_id","description":"\n\u003cp\u003eReviewer UUID (only admins and HR managers can change)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_date","full_name":"scheduled_date","description":"\n\u003cp\u003eScheduled review date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"completed_date","full_name":"completed_date","description":"\n\u003cp\u003eCompleted review date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"overall_score","full_name":"overall_score","description":"\n\u003cp\u003eOverall score (1-5 scale)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reviewer_feedback","full_name":"reviewer_feedback","description":"\n\u003cp\u003eReviewer feedback\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"career_progression_notes","full_name":"career_progression_notes","description":"\n\u003cp\u003eCareer progression notes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eReview status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003escheduled\u003c/code\u003e, \u003ccode\u003ein_progress\u003c/code\u003e, \u003ccode\u003ecompleted\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::PerformanceReviews/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/performance_reviews/:id","http_method":"DELETE","short_description":"Delete a performance review","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePerformance review UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::Schedules":{"doc_url":"/apipie/1.0/Hr::Schedules","id":"Hr::Schedules","api_url":"/api/v1","name":"Hr::Schedules","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Schedules/index","name":"index","apis":[{"api_url":"/api/v1/hr/schedules","http_method":"GET","short_description":"Get all schedules for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eSearch by schedule name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eFilter by active status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eFilter by default status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Schedules/create","name":"create","apis":[{"api_url":"/api/v1/hr/schedules","http_method":"POST","short_description":"Create a new schedule","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eSchedule name (e.g. ‘Full-time NYC’)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timezone","full_name":"timezone","description":"\n\u003cp\u003eIANA timezone (e.g. ‘America/New_York’)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_checkout_time","full_name":"auto_checkout_time","description":"\n\u003cp\u003eAuto checkout time (HH:MM)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eWhether this is the default schedule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eWhether this schedule is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_schedule_days_attributes","full_name":"hr_schedule_days_attributes","description":"\n\u003cp\u003eSchedule days\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"day_of_week","full_name":"hr_schedule_days_attributes[day_of_week]","description":"\n\u003cp\u003e0=Sunday, 1=Monday, … 6=Saturday\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_working_day","full_name":"hr_schedule_days_attributes[is_working_day]","description":"\n\u003cp\u003eWhether this is a working day\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_time","full_name":"hr_schedule_days_attributes[start_time]","description":"\n\u003cp\u003eStart time (HH:MM)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"hr_schedule_days_attributes[end_time]","description":"\n\u003cp\u003eEnd time (HH:MM)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expected_hours","full_name":"hr_schedule_days_attributes[expected_hours]","description":"\n\u003cp\u003eExpected work hours\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"break_duration_minutes","full_name":"hr_schedule_days_attributes[break_duration_minutes]","description":"\n\u003cp\u003eBreak duration in minutes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Schedules/show","name":"show","apis":[{"api_url":"/api/v1/hr/schedules/:id","http_method":"GET","short_description":"Get a specific schedule","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSchedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Schedules/update","name":"update","apis":[{"api_url":"/api/v1/hr/schedules/:id","http_method":"PUT","short_description":"Update a schedule","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSchedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSchedule name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timezone","full_name":"timezone","description":"\n\u003cp\u003eIANA timezone\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_checkout_time","full_name":"auto_checkout_time","description":"\n\u003cp\u003eAuto checkout time (HH:MM)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eWhether this is the default schedule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eWhether this schedule is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_schedule_days_attributes","full_name":"hr_schedule_days_attributes","description":"\n\u003cp\u003eSchedule days\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"hr_schedule_days_attributes[id]","description":"\n\u003cp\u003eSchedule day UUID (for update)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"hr_schedule_days_attributes[_destroy]","description":"\n\u003cp\u003eRemove this day\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_week","full_name":"hr_schedule_days_attributes[day_of_week]","description":"\n\u003cp\u003e0=Sunday, 1=Monday, … 6=Saturday\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_working_day","full_name":"hr_schedule_days_attributes[is_working_day]","description":"\n\u003cp\u003eWhether this is a working day\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_time","full_name":"hr_schedule_days_attributes[start_time]","description":"\n\u003cp\u003eStart time (HH:MM)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"hr_schedule_days_attributes[end_time]","description":"\n\u003cp\u003eEnd time (HH:MM)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expected_hours","full_name":"hr_schedule_days_attributes[expected_hours]","description":"\n\u003cp\u003eExpected work hours\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"break_duration_minutes","full_name":"hr_schedule_days_attributes[break_duration_minutes]","description":"\n\u003cp\u003eBreak duration in minutes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Schedules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/schedules/:id","http_method":"DELETE","short_description":"Delete a schedule","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSchedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::Summaries":{"doc_url":"/apipie/1.0/Hr::Summaries","id":"Hr::Summaries","api_url":"/api/v1","name":"Hr::Summaries","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Summaries/daily","name":"daily","apis":[{"api_url":"/api/v1/hr/summaries/daily","http_method":"GET","short_description":"Get daily attendance summaries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company daily summaries (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"\n\u003cp\u003eFilter by date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eFilter start date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eFilter end date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by status (attended, absent, leave, holiday, weekend, partial)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Summaries/weekly","name":"weekly","apis":[{"api_url":"/api/v1/hr/summaries/weekly","http_method":"GET","short_description":"Get weekly period summaries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company weekly summaries (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear (defaults to current year)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"week","full_name":"week","description":"\n\u003cp\u003eISO week number (defaults to current week)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Summaries/monthly","name":"monthly","apis":[{"api_url":"/api/v1/hr/summaries/monthly","http_method":"GET","short_description":"Get monthly period summaries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company monthly summaries (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear (defaults to current year)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"month","full_name":"month","description":"\n\u003cp\u003eMonth number 1-12 (defaults to current month)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Summaries/yearly","name":"yearly","apis":[{"api_url":"/api/v1/hr/summaries/yearly","http_method":"GET","short_description":"Get yearly period summaries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company yearly summaries (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear (defaults to current year)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Summaries/team","name":"team","apis":[{"api_url":"/api/v1/hr/summaries/team","http_method":"GET","short_description":"Get team daily summaries for a date","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"date","full_name":"date","description":"\n\u003cp\u003eDate (YYYY-MM-DD, defaults to today)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_id","full_name":"team_id","description":"\n\u003cp\u003eFilter by team UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::Teams":{"doc_url":"/apipie/1.0/Hr::Teams","id":"Hr::Teams","api_url":"/api/v1","name":"Hr::Teams","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Teams/index","name":"index","apis":[{"api_url":"/api/v1/hr/teams","http_method":"GET","short_description":"Get all teams for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_company_teams","full_name":"with_company_teams","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Teams/create","name":"create","apis":[{"api_url":"/api/v1/hr/teams","http_method":"POST","short_description":"Create a new team","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bio","full_name":"bio","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"participants","full_name":"participants","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"participants[ids]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role","full_name":"participants[role]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emember\u003c/code\u003e, \u003ccode\u003eadmin\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Teams/show","name":"show","apis":[{"api_url":"/api/v1/hr/teams/:id","http_method":"GET","short_description":"Get a specific team","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Teams/update","name":"update","apis":[{"api_url":"/api/v1/hr/teams/:id","http_method":"PUT","short_description":"Update a specific team","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bio","full_name":"bio","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Teams/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/teams/:id","http_method":"DELETE","short_description":"Delete a team by id","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::Trainings":{"doc_url":"/apipie/1.0/Hr::Trainings","id":"Hr::Trainings","api_url":"/api/v1","name":"Hr::Trainings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Trainings/index","name":"index","apis":[{"api_url":"/api/v1/hr/trainings","http_method":"GET","short_description":"List all trainings for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eFilter by category (company configuration UUID)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eFilter by active status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Trainings/show","name":"show","apis":[{"api_url":"/api/v1/hr/trainings/:id","http_method":"GET","short_description":"Get a specific training with summary stats","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTraining UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Trainings/create","name":"create","apis":[{"api_url":"/api/v1/hr/trainings","http_method":"POST","short_description":"Create a new training","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"title","full_name":"title","description":"\n\u003cp\u003eTraining title\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eTraining description\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eCategory (company configuration UUID with type hr_training_category)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eWhether the training is active (default: true)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Trainings/update","name":"update","apis":[{"api_url":"/api/v1/hr/trainings/:id","http_method":"PUT","short_description":"Update a training","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTraining UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eTraining title\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eTraining description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eCategory (company configuration UUID)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eWhether the training is active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Trainings/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/trainings/:id","http_method":"DELETE","short_description":"Soft-delete a training (set active to false)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTraining UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::UserSchedules":{"doc_url":"/apipie/1.0/Hr::UserSchedules","id":"Hr::UserSchedules","api_url":"/api/v1","name":"Hr::UserSchedules","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::UserSchedules/index","name":"index","apis":[{"api_url":"/api/v1/hr/user_schedules","http_method":"GET","short_description":"Get all user schedule assignments for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company user schedules (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_schedule_id","full_name":"hr_schedule_id","description":"\n\u003cp\u003eFilter by schedule UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserSchedules/create","name":"create","apis":[{"api_url":"/api/v1/hr/user_schedules","http_method":"POST","short_description":"Assign a schedule to a user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_schedule_id","full_name":"hr_schedule_id","description":"\n\u003cp\u003eSchedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_from","full_name":"effective_from","description":"\n\u003cp\u003eEffective from date (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_until","full_name":"effective_until","description":"\n\u003cp\u003eEffective until date (YYYY-MM-DD), null for indefinite\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserSchedules/show","name":"show","apis":[{"api_url":"/api/v1/hr/user_schedules/:id","http_method":"GET","short_description":"Get a specific user schedule assignment","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser schedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserSchedules/update","name":"update","apis":[{"api_url":"/api/v1/hr/user_schedules/:id","http_method":"PUT","short_description":"Update a user schedule assignment","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser schedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_schedule_id","full_name":"hr_schedule_id","description":"\n\u003cp\u003eSchedule UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_from","full_name":"effective_from","description":"\n\u003cp\u003eEffective from date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_until","full_name":"effective_until","description":"\n\u003cp\u003eEffective until date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserSchedules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/user_schedules/:id","http_method":"DELETE","short_description":"Delete a user schedule assignment","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser schedule UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::UserTrainings":{"doc_url":"/apipie/1.0/Hr::UserTrainings","id":"Hr::UserTrainings","api_url":"/api/v1","name":"Hr::UserTrainings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::UserTrainings/index","name":"index","apis":[{"api_url":"/api/v1/hr/user_trainings","http_method":"GET","short_description":"List all training assignments for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by status (pending, in_progress, completed)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"training_id","full_name":"training_id","description":"\n\u003cp\u003eFilter by training UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eSet to true to ignore company_user_id filter and return all trainings for the company (requires admin or HR manager permissions)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserTrainings/show","name":"show","apis":[{"api_url":"/api/v1/hr/user_trainings/:id","http_method":"GET","short_description":"Get a specific training assignment","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser training UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserTrainings/create","name":"create","apis":[{"api_url":"/api/v1/hr/user_trainings","http_method":"POST","short_description":"Assign a training to an employee","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"training_id","full_name":"training_id","description":"\n\u003cp\u003eTraining UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"\n\u003cp\u003eDeadline date (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStatus (default: pending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eOptional notes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserTrainings/update","name":"update","apis":[{"api_url":"/api/v1/hr/user_trainings/:id","http_method":"PUT","short_description":"Update a training assignment","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser training UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStatus\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"\n\u003cp\u003eDeadline date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eOptional notes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::UserTrainings/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/user_trainings/:id","http_method":"DELETE","short_description":"Delete a training assignment","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser training UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Kpi::Targets":{"doc_url":"/apipie/1.0/Kpi::Targets","id":"Kpi::Targets","api_url":"/api/v1","name":"Kpi::Targets","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Kpi::Targets/index","name":"index","apis":[{"api_url":"/api/v1/kpi/targets","http_method":"GET","short_description":"List all KPI targets","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_after","full_name":"start_after","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_before","full_name":"end_before","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_type","full_name":"target_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enumber_of_calendar_item\u003c/code\u003e, \u003ccode\u003enumber_of_tasks_completed\u003c/code\u003e, \u003ccode\u003enumber_of_matters_won\u003c/code\u003e, \u003ccode\u003enumber_of_leads_won\u003c/code\u003e, \u003ccode\u003etime_billed\u003c/code\u003e, \u003ccode\u003eutilization_rate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"frequency","full_name":"frequency","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ebiweekly\u003c/code\u003e, \u003ccode\u003emonthly\u003c/code\u003e, \u003ccode\u003ebimonthly\u003c/code\u003e, \u003ccode\u003equarterly\u003c/code\u003e, \u003ccode\u003esemi_annually\u003c/code\u003e, \u003ccode\u003eannually\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_by_user_id","full_name":"created_by_user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kpi::Targets/create","name":"create","apis":[{"api_url":"/api/v1/kpi/targets","http_method":"POST","short_description":"Create a KPI target","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"frequency","full_name":"frequency","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ebiweekly\u003c/code\u003e, \u003ccode\u003emonthly\u003c/code\u003e, \u003ccode\u003ebimonthly\u003c/code\u003e, \u003ccode\u003equarterly\u003c/code\u003e, \u003ccode\u003esemi_annually\u003c/code\u003e, \u003ccode\u003eannually\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_value","full_name":"target_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_type","full_name":"target_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enumber_of_calendar_item\u003c/code\u003e, \u003ccode\u003enumber_of_tasks_completed\u003c/code\u003e, \u003ccode\u003enumber_of_matters_won\u003c/code\u003e, \u003ccode\u003enumber_of_leads_won\u003c/code\u003e, \u003ccode\u003etime_billed\u003c/code\u003e, \u003ccode\u003eutilization_rate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kpi::Targets/show","name":"show","apis":[{"api_url":"/api/v1/kpi/targets/:id","http_method":"GET","short_description":"Show a KPI target","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kpi::Targets/update","name":"update","apis":[{"api_url":"/api/v1/kpi/targets/:id","http_method":"PUT","short_description":"Update a KPI target","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_type","full_name":"assigned_to_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eTeam\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assigned_to_id","full_name":"assigned_to_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"currency_id","full_name":"currency_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"frequency","full_name":"frequency","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ebiweekly\u003c/code\u003e, \u003ccode\u003emonthly\u003c/code\u003e, \u003ccode\u003ebimonthly\u003c/code\u003e, \u003ccode\u003equarterly\u003c/code\u003e, \u003ccode\u003esemi_annually\u003c/code\u003e, \u003ccode\u003eannually\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_value","full_name":"target_value","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_type","full_name":"target_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003enumber_of_calendar_item\u003c/code\u003e, \u003ccode\u003enumber_of_tasks_completed\u003c/code\u003e, \u003ccode\u003enumber_of_matters_won\u003c/code\u003e, \u003ccode\u003enumber_of_leads_won\u003c/code\u003e, \u003ccode\u003etime_billed\u003c/code\u003e, \u003ccode\u003eutilization_rate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kpi::Targets/destroy","name":"destroy","apis":[{"api_url":"/api/v1/kpi/targets/:id","http_method":"DELETE","short_description":"Delete a KPI target","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Kyc::DocumentTemplates":{"doc_url":"/apipie/1.0/Kyc::DocumentTemplates","id":"Kyc::DocumentTemplates","api_url":"/api/v1","name":"Kyc::DocumentTemplates","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Kyc::DocumentTemplates/index","name":"index","apis":[{"api_url":"/api/v1/kyc/document_templates","http_method":"GET","short_description":"Get all KYC document templates","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"type","full_name":"type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003earchived\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::DocumentTemplates/show","name":"show","apis":[{"api_url":"/api/v1/kyc/document_templates/:id","http_method":"GET","short_description":"Get a specific KYC document template","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::DocumentTemplates/create","name":"create","apis":[{"api_url":"/api/v1/kyc/document_templates","http_method":"POST","short_description":"Create a new KYC document template","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"document_template_elements","full_name":"document_template_elements","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"element_type","full_name":"document_template_elements[element_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile_attachment\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e, \u003ccode\u003etext\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e, \u003ccode\u003ecountry\u003c/code\u003e, \u003ccode\u003ephone_number\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e, \u003ccode\u003edrop_down\u003c/code\u003e, \u003ccode\u003emultiple_choice\u003c/code\u003e, \u003ccode\u003echeck_boxes\u003c/code\u003e, \u003ccode\u003etext_area\u003c/code\u003e, \u003ccode\u003esection_title\u003c/code\u003e, \u003ccode\u003edescription\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"document_template_elements[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"document_template_elements[data]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"document_template_elements[required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::DocumentTemplates/update","name":"update","apis":[{"api_url":"/api/v1/kyc/document_templates/:id","http_method":"PUT","short_description":"Update a KYC document template","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"document_template_elements","full_name":"document_template_elements","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"document_template_elements[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"document_template_elements[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"element_type","full_name":"document_template_elements[element_type]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003efile_attachment\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e, \u003ccode\u003etext\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e, \u003ccode\u003ecountry\u003c/code\u003e, \u003ccode\u003ephone_number\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e, \u003ccode\u003edrop_down\u003c/code\u003e, \u003ccode\u003emultiple_choice\u003c/code\u003e, \u003ccode\u003echeck_boxes\u003c/code\u003e, \u003ccode\u003etext_area\u003c/code\u003e, \u003ccode\u003esection_title\u003c/code\u003e, \u003ccode\u003edescription\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"document_template_elements[name]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"document_template_elements[sort_order]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"document_template_elements[data]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"document_template_elements[required]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::DocumentTemplates/destroy","name":"destroy","apis":[{"api_url":"/api/v1/kyc/document_templates/:id","http_method":"DELETE","short_description":"Delete a KYC document template","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Kyc::Documents":{"doc_url":"/apipie/1.0/Kyc::Documents","id":"Kyc::Documents","api_url":"/api/v1","name":"Kyc::Documents","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Kyc::Documents/index","name":"index","apis":[{"api_url":"/api/v1/kyc/documents","http_method":"GET","short_description":"Get all KYC documents","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"contact_id","full_name":"contact_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reviewer_id","full_name":"reviewer_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::Documents/show","name":"show","apis":[{"api_url":"/api/v1/kyc/documents/:id","http_method":"GET","short_description":"Get a specific KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::Documents/create","name":"create","apis":[{"api_url":"/api/v1/kyc/documents","http_method":"POST","short_description":"Create a new KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"contact_id","full_name":"contact_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::Documents/update","name":"update","apis":[{"api_url":"/api/v1/kyc/documents/:id","http_method":"PUT","short_description":"Update a KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"document_elements","full_name":"document_elements","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"document_elements[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"document_elements[value]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file","full_name":"document_elements[file]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_detach","full_name":"document_elements[file_detach]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::Documents/destroy","name":"destroy","apis":[{"api_url":"/api/v1/kyc/documents/:id","http_method":"DELETE","short_description":"Delete a KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::Documents/show_by_guid","name":"show_by_guid","apis":[{"api_url":"/api/v1/kyc/documents/guid/:guid","http_method":"GET","short_description":"Get a KYC document by GUID","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"guid","full_name":"guid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Kyc::Documents/update_by_guid","name":"update_by_guid","apis":[{"api_url":"/api/v1/kyc/documents/guid/:guid","http_method":"PUT","short_description":"Update a KYC document by GUID","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"guid","full_name":"guid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"document_elements","full_name":"document_elements","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"document_elements[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"document_elements[value]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file","full_name":"document_elements[file]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_detach","full_name":"document_elements[file_detach]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"archivals":{"doc_url":"/apipie/1.0/archivals","id":"archivals","api_url":"/api/v1","name":"Archivals","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/archivals/create","name":"create","apis":[{"api_url":"/api/v1/archive/task/:id","http_method":"PATCH","short_description":"Archive a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTask ID to archive\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/archivals/destroy","name":"destroy","apis":[{"api_url":"/api/v1/archive/task/:id","http_method":"DELETE","short_description":"Unarchive a task","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTask ID to unarchive\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Microsoft::Authentication":{"doc_url":"/apipie/1.0/Microsoft::Authentication","id":"Microsoft::Authentication","api_url":"/api/v1","name":"Microsoft::Authentication","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Authentication/authenticate","name":"authenticate","apis":[{"api_url":"/api/v1/microsoft/authenticate","http_method":"POST","short_description":"Store Microsoft token","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"code","full_name":"code","description":"\n\u003cp\u003eAuthorization code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"redirect_uri","full_name":"redirect_uri","description":"\n\u003cp\u003eRedirect URI\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scope_key","full_name":"scope_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecalendar\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::CalendarEvents":{"doc_url":"/apipie/1.0/Microsoft::CalendarEvents","id":"Microsoft::CalendarEvents","api_url":"/api/v1","name":"Microsoft::CalendarEvents","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::CalendarEvents/index","name":"index","apis":[{"api_url":"/api/v1/microsoft/calendar_events","http_method":"GET","short_description":"Get list of calendar events","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of events to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date for events\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/Microsoft::CalendarEvents/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/calendar_events","http_method":"POST","short_description":"Create calendar events","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subject","full_name":"subject","description":"\n\u003cp\u003eEvent subject\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eEvent content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_time","full_name":"start_time","description":"\n\u003cp\u003eEvent start time\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"end_time","description":"\n\u003cp\u003eEvent end time\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eEvent time zone\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attendees","full_name":"attendees","description":"\n\u003cp\u003eEvent attendees\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"Microsoft::EmailAccounts":{"doc_url":"/apipie/1.0/Microsoft::EmailAccounts","id":"Microsoft::EmailAccounts","api_url":"/api/v1","name":"Microsoft::EmailAccounts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::EmailAccounts/directories","name":"directories","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/directories","http_method":"GET","short_description":"Fetch email directories","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_directory_id","full_name":"parent_directory_id","description":"\n\u003cp\u003eParent directory ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailAccounts/profile_info","name":"profile_info","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/profile_info","http_method":"GET","short_description":"Fetch account profile information","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::EmailConversations":{"doc_url":"/apipie/1.0/Microsoft::EmailConversations","id":"Microsoft::EmailConversations","api_url":"/api/v1","name":"Microsoft::EmailConversations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::EmailConversations/index","name":"index","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_conversations","http_method":"GET","short_description":"Fetch directory conversations","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"directory","full_name":"directory","description":"\n\u003cp\u003eDirectory ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailConversations/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_conversations/:id","http_method":"GET","short_description":"Fetch conversation by ID","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailConversations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_conversations/:id","http_method":"DELETE","short_description":"Delete conversation by ID","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::EmailDrafts":{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts","id":"Microsoft::EmailDrafts","api_url":"/api/v1","name":"Microsoft::EmailDrafts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_drafts/:id","http_method":"GET","short_description":"Get email draft by id","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_drafts","http_method":"POST","short_description":"Create email as draft","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subject","full_name":"subject","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attachments","full_name":"attachments","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of Object","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receivers","full_name":"receivers","description":"\n\u003cp\u003eeach hash must include an email and type keys\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"receivers[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"receivers[type]","description":"\n\u003cp\u003ereceiver type (to, cc, bcc)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts/reply","name":"reply","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_drafts/reply","http_method":"POST","short_description":"Create email draft as reply","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reply_to_message_id","full_name":"reply_to_message_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reply_to_all","full_name":"reply_to_all","description":"\n\u003cp\u003eReply to all recipients\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attachments","full_name":"attachments","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of Object","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts/update","name":"update","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_drafts/:id","http_method":"PUT","short_description":"Update email draft","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subject","full_name":"subject","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reply_to_message_id","full_name":"reply_to_message_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reply_to_all","full_name":"reply_to_all","description":"\n\u003cp\u003eReply to all recipients\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attachments","full_name":"attachments","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of Object","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receivers","full_name":"receivers","description":"\n\u003cp\u003eeach hash must include an email and type keys\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"receivers[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"receivers[type]","description":"\n\u003cp\u003ereceiver type (to, cc, bcc)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_drafts/:id","http_method":"DELETE","short_description":"Delete an email draft","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails":{"doc_url":"/apipie/1.0/Microsoft::Emails","id":"Microsoft::Emails","api_url":"/api/v1","name":"Microsoft::Emails","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails","http_method":"POST","short_description":"Create email","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subject","full_name":"subject","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attachments","full_name":"attachments","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of Object","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receivers","full_name":"receivers","description":"\n\u003cp\u003eeach hash must include an email and type keys\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"receivers[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"receivers[type]","description":"\n\u003cp\u003ereceiver type (to, cc, bcc)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Emails/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:id","http_method":"DELETE","short_description":"Delete email","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Signatures":{"doc_url":"/apipie/1.0/Microsoft::Signatures","id":"Microsoft::Signatures","api_url":"/api/v1","name":"Microsoft::Signatures","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Signatures/index","name":"index","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/signatures","http_method":"GET","short_description":"Get all signatures","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"is_default","full_name":"is_default","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default_for_forwards_and_replies","full_name":"is_default_for_forwards_and_replies","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Signatures/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/signatures/:id","http_method":"GET","short_description":"Get signature by ID","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Signatures/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/signatures","http_method":"POST","short_description":"Create a signature","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature_html","full_name":"signature_html","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature_plain","full_name":"signature_plain","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default_for_forwards_and_replies","full_name":"is_default_for_forwards_and_replies","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Signatures/update","name":"update","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/signatures/:id","http_method":"PATCH","short_description":"update signature","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature_html","full_name":"signature_html","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature_plain","full_name":"signature_plain","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default_for_forwards_and_replies","full_name":"is_default_for_forwards_and_replies","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Signatures/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/signatures/:id","http_method":"DELETE","short_description":"Delete a signature","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"invoices":{"doc_url":"/apipie/1.0/invoices","id":"invoices","api_url":"/api/v1","name":"Invoices","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/invoices/create","name":"create","apis":[{"api_url":"/api/v1/milestones/:milestone_id/invoice","http_method":"POST","short_description":"Generate invoice for a milestone","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"milestone_id","full_name":"milestone_id","description":"\n\u003cp\u003eMilestone UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"counts":{"doc_url":"/apipie/1.0/counts","id":"counts","api_url":"/api/v1","name":"Counts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/counts/show","name":"show","apis":[{"api_url":"/api/v1/notifications/count","http_method":"GET","short_description":"Get notifications count per group type","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"view_receipts":{"doc_url":"/apipie/1.0/view_receipts","id":"view_receipts","api_url":"/api/v1","name":"View_receipts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/view_receipts/create","name":"create","apis":[{"api_url":"/api/v1/notifications/:notification_id/view_receipt","http_method":"POST","short_description":"Mark a single notification as viewed","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"notification_id","full_name":"notification_id","description":"\n\u003cp\u003eID of the notification to mark as viewed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/view_receipts/create_bulk","name":"create_bulk","apis":[{"api_url":"/api/v1/notifications/view_receipts","http_method":"POST","short_description":"Mark all unviewed notifications as viewed","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"notification_group_type","full_name":"notification_group_type","description":"\n\u003cp\u003eFilter by notification group type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eclient_related\u003c/code\u003e, \u003ccode\u003einternal\u003c/code\u003e, \u003ccode\u003ebilling_and_financial\u003c/code\u003e, \u003ccode\u003ecalendar_and_deadline\u003c/code\u003e, \u003ccode\u003egeneral\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"duplications":{"doc_url":"/apipie/1.0/duplications","id":"duplications","api_url":"/api/v1","name":"Duplications","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/duplications/create","name":"create","apis":[{"api_url":"/api/v1/sections/:section_id/duplication","http_method":"POST","short_description":"Duplicate a section","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"section_id","full_name":"section_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Sharing::Links":{"doc_url":"/apipie/1.0/Sharing::Links","id":"Sharing::Links","api_url":"/api/v1","name":"Sharing::Links","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Sharing::Links/index","name":"index","apis":[{"api_url":"/api/v1/sharing/links","http_method":"GET","short_description":"List my shared links","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Sharing::Links/show","name":"show","apis":[{"api_url":"/api/v1/sharing/links/:id","http_method":"GET","short_description":"View my shared link by ID","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Sharing::Links/create","name":"create","apis":[{"api_url":"/api/v1/sharing/links","http_method":"POST","short_description":"Create a new shared link","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"shareable_type","full_name":"shareable_type","description":"\n\u003cp\u003eType of resource to share (e.g., ‘Storage::File’)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shareable_id","full_name":"shareable_id","description":"\n\u003cp\u003eID of resource to share\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expires_at","full_name":"expires_at","description":"\n\u003cp\u003eExpiration date (ISO 8601 format)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_views_count","full_name":"max_views_count","description":"\n\u003cp\u003eMaximum number of views allowed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword to protect the link\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Sharing::Links/update","name":"update","apis":[{"api_url":"/api/v1/sharing/links/:id","http_method":"PATCH","short_description":"Update my shared link","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expires_at","full_name":"expires_at","description":"\n\u003cp\u003eExpiration date (ISO 8601 format)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_views_count","full_name":"max_views_count","description":"\n\u003cp\u003eMaximum number of views allowed\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword to protect the link (empty string to remove)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Sharing::Links/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sharing/links/:id","http_method":"DELETE","short_description":"Delete my shared link","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Sharing::Shared":{"doc_url":"/apipie/1.0/Sharing::Shared","id":"Sharing::Shared","api_url":"/api/v1","name":"Sharing::Shared","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Sharing::Shared/show","name":"show","apis":[{"api_url":"/api/v1/sharing/shared/:id","http_method":"GET","short_description":"View shared resource by id (no password)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSharing link id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Sharing::Shared/access","name":"access","apis":[{"api_url":"/api/v1/sharing/shared/:id/access","http_method":"POST","short_description":"Access password-protected shared resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSharing link id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for the shared link\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Categories":{"doc_url":"/apipie/1.0/Storage::Categories","id":"Storage::Categories","api_url":"/api/v1","name":"Storage::Categories","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Categories/index","name":"index","apis":[{"api_url":"/api/v1/storage/categories","http_method":"GET","short_description":"Get all storage categories for current company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Categories/create","name":"create","apis":[{"api_url":"/api/v1/storage/categories","http_method":"POST","short_description":"Create a new storage category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Categories/show","name":"show","apis":[{"api_url":"/api/v1/storage/categories/:id","http_method":"GET","short_description":"Get a storage category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Categories/update","name":"update","apis":[{"api_url":"/api/v1/storage/categories/:id","http_method":"PUT","short_description":"Update a storage category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Categories/destroy","name":"destroy","apis":[{"api_url":"/api/v1/storage/categories/:id","http_method":"DELETE","short_description":"Delete a storage category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Files":{"doc_url":"/apipie/1.0/Storage::Files","id":"Storage::Files","api_url":"/api/v1","name":"Storage::Files","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Files/create","name":"create","apis":[{"api_url":"/api/v1/storage/files","http_method":"POST","short_description":"Create a new storage file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file","full_name":"file","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expiration_date","full_name":"expiration_date","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_type","full_name":"parent_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Files/show","name":"show","apis":[{"api_url":"/api/v1/storage/files/:id","http_method":"GET","short_description":"Get a storage file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Files/update","name":"update","apis":[{"api_url":"/api/v1/storage/files/:id","http_method":"PUT","short_description":"Update a storage file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expiration_date","full_name":"expiration_date","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"item_labels_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"item_labels_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/storage/files/:id","http_method":"DELETE","short_description":"Delete a storage file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Folders":{"doc_url":"/apipie/1.0/Storage::Folders","id":"Storage::Folders","api_url":"/api/v1","name":"Storage::Folders","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Folders/create","name":"create","apis":[{"api_url":"/api/v1/storage/folders","http_method":"POST","short_description":"Create a new storage folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_type","full_name":"parent_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Folders/show","name":"show","apis":[{"api_url":"/api/v1/storage/folders/:id","http_method":"GET","short_description":"Get a storage folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Folders/update","name":"update","apis":[{"api_url":"/api/v1/storage/folders/:id","http_method":"PUT","short_description":"Update a storage folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_labels_attributes","full_name":"item_labels_attributes","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"item_labels_attributes[id]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"_destroy","full_name":"item_labels_attributes[_destroy]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label_id","full_name":"item_labels_attributes[label_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Storage::Folders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/storage/folders/:id","http_method":"DELETE","short_description":"Delete a storage folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::QueryableFolders":{"doc_url":"/apipie/1.0/Storage::QueryableFolders","id":"Storage::QueryableFolders","api_url":"/api/v1","name":"Storage::QueryableFolders","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::QueryableFolders/show","name":"show","apis":[{"api_url":"/api/v1/storage/queryable_folders/:key","http_method":"GET","short_description":"Get a queryable folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003ekey: klass#related_to_type#related_to_id or just klass; accepted classes: Contact, LegalMatter, Lead, Hearing, Task, CompanyUser\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"account_deletions":{"doc_url":"/apipie/1.0/account_deletions","id":"account_deletions","api_url":"/api/v1","name":"Account_deletions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/account_deletions/create","name":"create","apis":[{"api_url":"/api/v1/users/account_deletion","http_method":"POST","short_description":"Request account deletion (GDPR Art. 17)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"password","full_name":"password","description":"\n\u003cp\u003eCurrent password for confirmation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"data_exports":{"doc_url":"/apipie/1.0/data_exports","id":"data_exports","api_url":"/api/v1","name":"Data_exports","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/data_exports/create","name":"create","apis":[{"api_url":"/api/v1/users/data_export","http_method":"POST","short_description":"Request personal data export (GDPR Art. 15/20)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"password_reset_requests":{"doc_url":"/apipie/1.0/password_reset_requests","id":"password_reset_requests","api_url":"/api/v1","name":"Password_reset_requests","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/password_reset_requests/create","name":"create","apis":[{"api_url":"/api/v1/users/password_reset_request","http_method":"POST","short_description":"Request a password reset","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"password_resets":{"doc_url":"/apipie/1.0/password_resets","id":"password_resets","api_url":"/api/v1","name":"Password_resets","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/password_resets/create","name":"create","apis":[{"api_url":"/api/v1/users/password_reset","http_method":"POST","short_description":"Reset your password","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"reset_password_token","full_name":"reset_password_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"passwords":{"doc_url":"/apipie/1.0/passwords","id":"passwords","api_url":"/api/v1","name":"Passwords","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/passwords/update","name":"update","apis":[{"api_url":"/api/v1/users/password","http_method":"PUT","short_description":"Change your password","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"new_password","full_name":"new_password","description":"\n\u003cp\u003eThe new password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_password","full_name":"current_password","description":"\n\u003cp\u003eCurrent password (required only when user has previously set a password)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"workspaces":{"doc_url":"/apipie/1.0/workspaces","id":"workspaces","api_url":"/api/v1","name":"Workspaces","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/workspaces/update","name":"update","apis":[{"api_url":"/api/v1/users/workspace","http_method":"PUT","short_description":"Change your workspace","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"hr_actions":{"doc_url":"/apipie/1.0/hr_actions","id":"hr_actions","api_url":"/api/v1","name":"Hr_actions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/hr_actions/index","name":"index","apis":[{"api_url":"/api/v1/versions/hr_actions","http_method":"GET","short_description":"Get all HR audit log actions for a specific company user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eID of the company user to get HR actions for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Automation::Automations::Activations":{"doc_url":"/apipie/1.0/Automation::Automations::Activations","id":"Automation::Automations::Activations","api_url":"/api/v1","name":"Automation::Automations::Activations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Automation::Automations::Activations/create","name":"create","apis":[{"api_url":"/api/v1/automation/automations/:automation_id/activation","http_method":"POST","short_description":"Activate an automation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"automation_id","full_name":"automation_id","description":"\n\u003cp\u003eAutomation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Automation::Automations::Activations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/automation/automations/:automation_id/activation","http_method":"DELETE","short_description":"Deactivate an automation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"automation_id","full_name":"automation_id","description":"\n\u003cp\u003eAutomation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Automation::Automations::TestRuns":{"doc_url":"/apipie/1.0/Automation::Automations::TestRuns","id":"Automation::Automations::TestRuns","api_url":"/api/v1","name":"Automation::Automations::TestRuns","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Automation::Automations::TestRuns/create","name":"create","apis":[{"api_url":"/api/v1/automation/automations/:automation_id/test_run","http_method":"POST","short_description":"Test an automation with sample data","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"automation_id","full_name":"automation_id","description":"\n\u003cp\u003eAutomation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sample_trigger_object","full_name":"sample_trigger_object","description":"\n\u003cp\u003eSample trigger object for testing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Automation::Runs::Retries":{"doc_url":"/apipie/1.0/Automation::Runs::Retries","id":"Automation::Runs::Retries","api_url":"/api/v1","name":"Automation::Runs::Retries","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Automation::Runs::Retries/create","name":"create","apis":[{"api_url":"/api/v1/automation/runs/:run_id/retry","http_method":"POST","short_description":"Retry a failed automation run","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"run_id","full_name":"run_id","description":"\n\u003cp\u003eAutomation run UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Chat::Conversations::Memberships":{"doc_url":"/apipie/1.0/Chat::Conversations::Memberships","id":"Chat::Conversations::Memberships","api_url":"/api/v1","name":"Chat::Conversations::Memberships","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Chat::Conversations::Memberships/create","name":"create","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/membership","http_method":"POST","short_description":"Join a conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Conversations::Memberships/destroy","name":"destroy","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/membership","http_method":"DELETE","short_description":"Leave a conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Chat::Conversations::Participants":{"doc_url":"/apipie/1.0/Chat::Conversations::Participants","id":"Chat::Conversations::Participants","api_url":"/api/v1","name":"Chat::Conversations::Participants","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Chat::Conversations::Participants/create","name":"create","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/participants","http_method":"POST","short_description":"Add participants to a conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"user_ids","description":"\n\u003cp\u003eIDs of the users to add as participants\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Conversations::Participants/destroy","name":"destroy","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/participants","http_method":"DELETE","short_description":"Remove participants from a conversation","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"user_ids","description":"\n\u003cp\u003eIDs of the users to remove from the conversation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Chat::Conversations::ReadReceipts":{"doc_url":"/apipie/1.0/Chat::Conversations::ReadReceipts","id":"Chat::Conversations::ReadReceipts","api_url":"/api/v1","name":"Chat::Conversations::ReadReceipts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Chat::Conversations::ReadReceipts/create","name":"create","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/read_receipt","http_method":"POST","short_description":"Mark a conversation as read","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Chat::Messages::ReadReceipts":{"doc_url":"/apipie/1.0/Chat::Messages::ReadReceipts","id":"Chat::Messages::ReadReceipts","api_url":"/api/v1","name":"Chat::Messages::ReadReceipts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Chat::Messages::ReadReceipts/create","name":"create","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages/:message_id/read_receipt","http_method":"POST","short_description":"Mark a message as read","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_id","full_name":"message_id","description":"\n\u003cp\u003eMessage UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Chat::Messages::ReadReceipts/create_bulk","name":"create_bulk","apis":[{"api_url":"/api/v1/chat/conversations/:conversation_id/messages/mark_multiple_as_read","http_method":"POST","short_description":"Mark all conversation messages as read","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"conversation_id","full_name":"conversation_id","description":"\n\u003cp\u003eConversation UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Client::Financial::Invoices":{"doc_url":"/apipie/1.0/Client::Financial::Invoices","id":"Client::Financial::Invoices","api_url":"/api/v1","name":"Client::Financial::Invoices","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Client::Financial::Invoices/index","name":"index","apis":[{"api_url":"/api/v1/client/financial/invoices","http_method":"GET","short_description":"Get all client invoices","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003epaid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Client::Financial::Invoices/show","name":"show","apis":[{"api_url":"/api/v1/client/financial/invoices/:id","http_method":"GET","short_description":"Get a invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Client::Kyc::Documents":{"doc_url":"/apipie/1.0/Client::Kyc::Documents","id":"Client::Kyc::Documents","api_url":"/api/v1","name":"Client::Kyc::Documents","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Client::Kyc::Documents/index","name":"index","apis":[{"api_url":"/api/v1/client/kyc/documents","http_method":"GET","short_description":"Get all client KYC documents","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"reviewer_id","full_name":"reviewer_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Client::Kyc::Documents/show","name":"show","apis":[{"api_url":"/api/v1/client/kyc/documents/:id","http_method":"GET","short_description":"Get a specific KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"break_ends":{"doc_url":"/apipie/1.0/break_ends","id":"break_ends","api_url":"/api/v1","name":"Break_ends","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/break_ends/create","name":"create","apis":[{"api_url":"/api/v1/hr/attendance/break_end","http_method":"POST","short_description":"End a break","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"break_starts":{"doc_url":"/apipie/1.0/break_starts","id":"break_starts","api_url":"/api/v1","name":"Break_starts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/break_starts/create","name":"create","apis":[{"api_url":"/api/v1/hr/attendance/break_start","http_method":"POST","short_description":"Start a break","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"check_ins":{"doc_url":"/apipie/1.0/check_ins","id":"check_ins","api_url":"/api/v1","name":"Check_ins","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/check_ins/create","name":"create","apis":[{"api_url":"/api/v1/hr/attendance/check_in","http_method":"POST","short_description":"Check in to work","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip_address","full_name":"ip_address","description":"\n\u003cp\u003eIP address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_lat","full_name":"location_lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_lng","full_name":"location_lng","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"device_info","full_name":"device_info","description":"\n\u003cp\u003eDevice information\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"check_outs":{"doc_url":"/apipie/1.0/check_outs","id":"check_outs","api_url":"/api/v1","name":"Check_outs","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/check_outs/create","name":"create","apis":[{"api_url":"/api/v1/hr/attendance/check_out","http_method":"POST","short_description":"Check out from work","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"records":{"doc_url":"/apipie/1.0/records","id":"records","api_url":"/api/v1","name":"Records","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/records/index","name":"index","apis":[{"api_url":"/api/v1/hr/attendance/records","http_method":"GET","short_description":"Get attendance records","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eFilter by employee UUID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"for_whole_company","full_name":"for_whole_company","description":"\n\u003cp\u003eReturn all company attendance records (requires read permission)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"\n\u003cp\u003eFilter by date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_type","full_name":"record_type","description":"\n\u003cp\u003eFilter by record type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/records/create","name":"create","apis":[{"api_url":"/api/v1/hr/attendance/records","http_method":"POST","short_description":"Create a manual attendance record","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_type","full_name":"record_type","description":"\n\u003cp\u003eRecord type (check_in, check_out, break_start, break_end)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recorded_at","full_name":"recorded_at","description":"\n\u003cp\u003eTime of record (ISO 8601)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"\n\u003cp\u003eDate (YYYY-MM-DD)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/records/update","name":"update","apis":[{"api_url":"/api/v1/hr/attendance/records/:id","http_method":"PATCH","short_description":"Edit an attendance record","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAttendance record UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recorded_at","full_name":"recorded_at","description":"\n\u003cp\u003eNew time (ISO 8601)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"status":{"doc_url":"/apipie/1.0/status","id":"status","api_url":"/api/v1","name":"Status","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/status/show","name":"show","apis":[{"api_url":"/api/v1/hr/attendance/current_status","http_method":"GET","short_description":"Get current attendance status","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID (defaults to current user)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Hr::CompanyPolicyCategories::Acknowledgments":{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories::Acknowledgments","id":"Hr::CompanyPolicyCategories::Acknowledgments","api_url":"/api/v1","name":"Hr::CompanyPolicyCategories::Acknowledgments","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories::Acknowledgments/create","name":"create","apis":[{"api_url":"/api/v1/hr/company_policy_categories/:company_policy_category_id/acknowledgment","http_method":"POST","short_description":"Acknowledge a policy category","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_policy_category_id","full_name":"company_policy_category_id","description":"\n\u003cp\u003eCompany policy category UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories::Acknowledgments/show","name":"show","apis":[{"api_url":"/api/v1/hr/company_policy_categories/:company_policy_category_id/acknowledgment","http_method":"GET","short_description":"Get acknowledgment status for current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_policy_category_id","full_name":"company_policy_category_id","description":"\n\u003cp\u003eCompany policy category UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::CompanyPolicyCategories::Acknowledgments/index","name":"index","apis":[{"api_url":"/api/v1/hr/company_policy_categories/:company_policy_category_id/acknowledgments","http_method":"GET","short_description":"List acknowledgments for a policy category (admin)","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number - starts at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_format","full_name":"response_format","description":"\n\u003cp\u003eResponse format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns_to_export","full_name":"columns_to_export","description":"\n\u003cp\u003eColumns to export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_field","full_name":"sort_by_field","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by_direction","full_name":"sort_by_direction","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eMulti-column sort\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"field","full_name":"sort_by[field]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"sort_by[direction]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"column","full_name":"q[column]","description":"\n\u003cp\u003eField name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator","full_name":"q[operator]","description":"\n\u003cp\u003eOperator\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeq\u003c/code\u003e, \u003ccode\u003enot_eq\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003elteq\u003c/code\u003e, \u003ccode\u003egt\u003c/code\u003e, \u003ccode\u003egteq\u003c/code\u003e, \u003ccode\u003econtains\u003c/code\u003e, \u003ccode\u003enot_contains\u003c/code\u003e, \u003ccode\u003estarts_with\u003c/code\u003e, \u003ccode\u003eends_with\u003c/code\u003e, \u003ccode\u003ein\u003c/code\u003e, \u003ccode\u003enot_in\u003c/code\u003e, \u003ccode\u003epresent\u003c/code\u003e, \u003ccode\u003enot_present\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"q[value]","description":"\n\u003cp\u003eValue: can be string, array, etc…\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"company_policy_category_id","full_name":"company_policy_category_id","description":"\n\u003cp\u003eCompany policy category UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eSearch by user name/email\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eFilter by whether acknowledgment is current\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eacknowledged\u003c/code\u003e, \u003ccode\u003eoutdated\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"grouped":{"doc_url":"/apipie/1.0/grouped","id":"grouped","api_url":"/api/v1","name":"Grouped","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/grouped/index","name":"index","apis":[{"api_url":"/api/v1/hr/company_policy_categories/grouped","http_method":"GET","short_description":"List all categories with their policies","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"my_acknowledgments":{"doc_url":"/apipie/1.0/my_acknowledgments","id":"my_acknowledgments","api_url":"/api/v1","name":"My_acknowledgments","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/my_acknowledgments/index","name":"index","apis":[{"api_url":"/api/v1/hr/company_policy_categories/my_acknowledgments","http_method":"GET","short_description":"Get all category acknowledgment statuses for current user","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"adjust_by_lookup":{"doc_url":"/apipie/1.0/adjust_by_lookup","id":"adjust_by_lookup","api_url":"/api/v1","name":"Adjust_by_lookup","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/adjust_by_lookup/create","name":"create","apis":[{"api_url":"/api/v1/hr/leave_balances/adjust_by_lookup","http_method":"POST","short_description":"Adjust a leave balance by employee and leave type lookup","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_user_id","full_name":"company_user_id","description":"\n\u003cp\u003eEmployee UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hr_leave_type_id","full_name":"hr_leave_type_id","description":"\n\u003cp\u003eLeave type UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eBalance year (defaults to current year)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"amount","full_name":"amount","description":"\n\u003cp\u003eAdjustment amount (positive to add, negative to deduct)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"reason","description":"\n\u003cp\u003eReason for adjustment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Hr::LeaveBalances::Adjustments":{"doc_url":"/apipie/1.0/Hr::LeaveBalances::Adjustments","id":"Hr::LeaveBalances::Adjustments","api_url":"/api/v1","name":"Hr::LeaveBalances::Adjustments","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::LeaveBalances::Adjustments/create","name":"create","apis":[{"api_url":"/api/v1/hr/leave_balances/:leave_balance_id/adjustment","http_method":"POST","short_description":"Adjust a leave balance manually","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"leave_balance_id","full_name":"leave_balance_id","description":"\n\u003cp\u003eLeave balance UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"amount","full_name":"amount","description":"\n\u003cp\u003eAdjustment amount (positive to add, negative to deduct)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"reason","description":"\n\u003cp\u003eReason for adjustment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::LeaveRequests::Approvals":{"doc_url":"/apipie/1.0/Hr::LeaveRequests::Approvals","id":"Hr::LeaveRequests::Approvals","api_url":"/api/v1","name":"Hr::LeaveRequests::Approvals","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::LeaveRequests::Approvals/create","name":"create","apis":[{"api_url":"/api/v1/hr/leave_requests/:leave_request_id/approval","http_method":"POST","short_description":"Approve a leave request","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"leave_request_id","full_name":"leave_request_id","description":"\n\u003cp\u003eLeave request UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::LeaveRequests::Rejections":{"doc_url":"/apipie/1.0/Hr::LeaveRequests::Rejections","id":"Hr::LeaveRequests::Rejections","api_url":"/api/v1","name":"Hr::LeaveRequests::Rejections","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::LeaveRequests::Rejections/create","name":"create","apis":[{"api_url":"/api/v1/hr/leave_requests/:leave_request_id/rejection","http_method":"POST","short_description":"Reject a leave request","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"leave_request_id","full_name":"leave_request_id","description":"\n\u003cp\u003eLeave request UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rejection_reason","full_name":"rejection_reason","description":"\n\u003cp\u003eReason for rejection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::Teams::Participants":{"doc_url":"/apipie/1.0/Hr::Teams::Participants","id":"Hr::Teams::Participants","api_url":"/api/v1","name":"Hr::Teams::Participants","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Teams::Participants/create","name":"create","apis":[{"api_url":"/api/v1/hr/teams/:team_id/participants","http_method":"POST","short_description":"Add participants to a team","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"team_id","full_name":"team_id","description":"\n\u003cp\u003eTeam UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"participant_ids","full_name":"participant_ids","description":"\n\u003cp\u003eArray of company user UUIDs to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role","full_name":"role","description":"\n\u003cp\u003eRole for the participants\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emember\u003c/code\u003e, \u003ccode\u003eadmin\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Hr::Teams::Participants/destroy","name":"destroy","apis":[{"api_url":"/api/v1/hr/teams/:team_id/participants","http_method":"DELETE","short_description":"Remove participants from a team","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"team_id","full_name":"team_id","description":"\n\u003cp\u003eTeam UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"participant_ids","full_name":"participant_ids","description":"\n\u003cp\u003eArray of company user UUIDs to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"tree":{"doc_url":"/apipie/1.0/tree","id":"tree","api_url":"/api/v1","name":"Tree","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/tree/show","name":"show","apis":[{"api_url":"/api/v1/hr/teams/tree","http_method":"GET","short_description":"Get tree structure of teams","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"Hr::Trainings::Assignments":{"doc_url":"/apipie/1.0/Hr::Trainings::Assignments","id":"Hr::Trainings::Assignments","api_url":"/api/v1","name":"Hr::Trainings::Assignments","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::Trainings::Assignments/create","name":"create","apis":[{"api_url":"/api/v1/hr/trainings/:training_id/assignments","http_method":"POST","short_description":"Assign training to multiple employees at once","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"training_id","full_name":"training_id","description":"\n\u003cp\u003eTraining UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_user_ids","full_name":"company_user_ids","description":"\n\u003cp\u003eArray of company user UUIDs to assign\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"due_date","full_name":"due_date","description":"\n\u003cp\u003eDeadline date (YYYY-MM-DD) for all assignments\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Hr::UserTrainings::Completions":{"doc_url":"/apipie/1.0/Hr::UserTrainings::Completions","id":"Hr::UserTrainings::Completions","api_url":"/api/v1","name":"Hr::UserTrainings::Completions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Hr::UserTrainings::Completions/create","name":"create","apis":[{"api_url":"/api/v1/hr/user_trainings/:user_training_id/completion","http_method":"POST","short_description":"Mark a training assignment as complete","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"user_training_id","full_name":"user_training_id","description":"\n\u003cp\u003eUser training UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Kyc::Documents::Approvals":{"doc_url":"/apipie/1.0/Kyc::Documents::Approvals","id":"Kyc::Documents::Approvals","api_url":"/api/v1","name":"Kyc::Documents::Approvals","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Kyc::Documents::Approvals/create","name":"create","apis":[{"api_url":"/api/v1/kyc/documents/:document_id/approval","http_method":"POST","short_description":"Approve a KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"document_id","full_name":"document_id","description":"\n\u003cp\u003eKYC document UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Kyc::Documents::Rejections":{"doc_url":"/apipie/1.0/Kyc::Documents::Rejections","id":"Kyc::Documents::Rejections","api_url":"/api/v1","name":"Kyc::Documents::Rejections","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Kyc::Documents::Rejections/create","name":"create","apis":[{"api_url":"/api/v1/kyc/documents/:document_id/rejection","http_method":"POST","short_description":"Reject a KYC document","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"document_id","full_name":"document_id","description":"\n\u003cp\u003eKYC document UUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rejection_reason","full_name":"rejection_reason","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::EmailDrafts::Deliveries":{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts::Deliveries","id":"Microsoft::EmailDrafts::Deliveries","api_url":"/api/v1","name":"Microsoft::EmailDrafts::Deliveries","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::EmailDrafts::Deliveries/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/email_drafts/:email_draft_id/delivery","http_method":"POST","short_description":"Send email draft","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_draft_id","full_name":"email_draft_id","description":"\n\u003cp\u003eEmail draft ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails::Archivals":{"doc_url":"/apipie/1.0/Microsoft::Emails::Archivals","id":"Microsoft::Emails::Archivals","api_url":"/api/v1","name":"Microsoft::Emails::Archivals","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails::Archivals/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/archival","http_method":"POST","short_description":"Archive email","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails::Attachments":{"doc_url":"/apipie/1.0/Microsoft::Emails::Attachments","id":"Microsoft::Emails::Attachments","api_url":"/api/v1","name":"Microsoft::Emails::Attachments","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails::Attachments/index","name":"index","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/attachments","http_method":"GET","short_description":"Fetch email attachments","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails::Forwardings":{"doc_url":"/apipie/1.0/Microsoft::Emails::Forwardings","id":"Microsoft::Emails::Forwardings","api_url":"/api/v1","name":"Microsoft::Emails::Forwardings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails::Forwardings/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/forwarding","http_method":"POST","short_description":"Forward email","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receivers","full_name":"receivers","description":"\n\u003cp\u003eeach hash must include an email and type keys\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"receivers[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"receivers[type]","description":"\n\u003cp\u003ereceiver type (to, cc, bcc)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails::ReadReceipts":{"doc_url":"/apipie/1.0/Microsoft::Emails::ReadReceipts","id":"Microsoft::Emails::ReadReceipts","api_url":"/api/v1","name":"Microsoft::Emails::ReadReceipts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails::ReadReceipts/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/read_receipt","http_method":"POST","short_description":"Mark email as read","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Emails::ReadReceipts/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/read_receipt","http_method":"DELETE","short_description":"Mark email as unread","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails::Relocations":{"doc_url":"/apipie/1.0/Microsoft::Emails::Relocations","id":"Microsoft::Emails::Relocations","api_url":"/api/v1","name":"Microsoft::Emails::Relocations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails::Relocations/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/relocation","http_method":"POST","short_description":"Move email to folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"folder_id","full_name":"folder_id","description":"\n\u003cp\u003eDestination folder ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Emails::Replies":{"doc_url":"/apipie/1.0/Microsoft::Emails::Replies","id":"Microsoft::Emails::Replies","api_url":"/api/v1","name":"Microsoft::Emails::Replies","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Emails::Replies/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/email_account/:account_id/emails/:email_id/reply","http_method":"POST","short_description":"Reply to email","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_id","full_name":"email_id","description":"\n\u003cp\u003eEmail ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to_all","full_name":"to_all","description":"\n\u003cp\u003eReply to all recipients\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attachments","full_name":"attachments","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an array of Object","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"receivers","full_name":"receivers","description":"\n\u003cp\u003eeach hash must include an email and type keys\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"receivers[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"receivers[type]","description":"\n\u003cp\u003ereceiver type (to, cc, bcc)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Delta":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Delta","id":"Microsoft::Sharepoint::Delta","api_url":"/api/v1","name":"Microsoft::Sharepoint::Delta","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Delta/index","name":"index","apis":[{"api_url":"/api/v1/microsoft/sharepoint/delta","http_method":"GET","short_description":"SharePoint: get delta changes","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"changes_since","full_name":"changes_since","description":"\n\u003cp\u003eFilter changes since a specific time period\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003elast_day\u003c/code\u003e, \u003ccode\u003elast_week\u003c/code\u003e, \u003ccode\u003elast_month\u003c/code\u003e, \u003ccode\u003elast_quarter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Delta/actions","name":"actions","apis":[{"api_url":"/api/v1/microsoft/sharepoint/delta/:item_type/:item_id/actions","http_method":"GET","short_description":"SharePoint: get delta actions of specific item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"item_type","full_name":"item_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_id","full_name":"item_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Delta/action_process","name":"action_process","apis":[{"api_url":"/api/v1/microsoft/sharepoint/delta/:item_type/:item_id/actions","http_method":"POST","short_description":"SharePoint: process action of specific item","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"item_type","full_name":"item_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"item_id","full_name":"item_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"process_action_name","full_name":"process_action_name","description":"\n\u003cp\u003eName of the action to perform\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"process_action_params","full_name":"process_action_params","description":"\n\u003cp\u003eParameters for the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Files":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Files","id":"Microsoft::Sharepoint::Files","api_url":"/api/v1","name":"Microsoft::Sharepoint::Files","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Files/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/sharepoint/files/:id","http_method":"GET","short_description":"SharePoint: get a file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Files/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/sharepoint/files","http_method":"POST","short_description":"SharePoint: create a file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"parent_id","full_name":"parent_id","description":"\n\u003cp\u003eID of the parent folder\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the file to create (optional if using original filename)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expiration_date","full_name":"expiration_date","description":"\n\u003cp\u003eExpiration date of the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extra_data","full_name":"extra_data","description":"\n\u003cp\u003eExtra data to pass to custom code ( if any )\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Object","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Files/update","name":"update","apis":[{"api_url":"/api/v1/microsoft/sharepoint/files/:id","http_method":"PUT","short_description":"SharePoint: update a file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the file to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"\n\u003cp\u003eID of the parent folder ( to move to )\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expiration_date","full_name":"expiration_date","description":"\n\u003cp\u003eExpiration date of the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/sharepoint/files/:id","http_method":"DELETE","short_description":"SharePoint: delete a file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Folders":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Folders","id":"Microsoft::Sharepoint::Folders","api_url":"/api/v1","name":"Microsoft::Sharepoint::Folders","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Folders/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/sharepoint/folders","http_method":"POST","short_description":"SharePoint: create a folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"parent_id","full_name":"parent_id","description":"\n\u003cp\u003eID of the folder\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the folder to create\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Folders/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/sharepoint/folders/:id","http_method":"GET","short_description":"SharePoint: get a folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the folder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Folders/update","name":"update","apis":[{"api_url":"/api/v1/microsoft/sharepoint/folders/:id","http_method":"PUT","short_description":"SharePoint: update a folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the folder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the folder to create\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Folders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/microsoft/sharepoint/folders/:id","http_method":"DELETE","short_description":"SharePoint: delete a folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the folder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Root":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Root","id":"Microsoft::Sharepoint::Root","api_url":"/api/v1","name":"Microsoft::Sharepoint::Root","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Root/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/sharepoint/root","http_method":"GET","short_description":"SharePoint: get root folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Balances":{"doc_url":"/apipie/1.0/Payment::Stripe::Balances","id":"Payment::Stripe::Balances","api_url":"/api/v1","name":"Payment::Stripe::Balances","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Balances/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/balance","http_method":"GET","short_description":"Get customer account balance","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Charges":{"doc_url":"/apipie/1.0/Payment::Stripe::Charges","id":"Payment::Stripe::Charges","api_url":"/api/v1","name":"Payment::Stripe::Charges","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Charges/index","name":"index","apis":[{"api_url":"/api/v1/payment/stripe/charges","http_method":"GET","short_description":"List payment charges and receipts","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of charges to return (max 100)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"starting_after","full_name":"starting_after","description":"\n\u003cp\u003eCursor for pagination (charge ID)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::Charges/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/charges/:id","http_method":"GET","short_description":"Get a single charge with receipt","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe charge ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Customer":{"doc_url":"/apipie/1.0/Payment::Stripe::Customer","id":"Payment::Stripe::Customer","api_url":"/api/v1","name":"Payment::Stripe::Customer","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Customer/portal","name":"portal","apis":[{"api_url":"/api/v1/payment/stripe/customer/portal","http_method":"POST","short_description":"Get stripe customer portal link","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"return_url","full_name":"return_url","description":"\n\u003cp\u003eThe URL to redirect to url\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Invoices":{"doc_url":"/apipie/1.0/Payment::Stripe::Invoices","id":"Payment::Stripe::Invoices","api_url":"/api/v1","name":"Payment::Stripe::Invoices","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Invoices/index","name":"index","apis":[{"api_url":"/api/v1/payment/stripe/invoices","http_method":"GET","short_description":"List past invoices for the company","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of invoices to return (max 100)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"starting_after","full_name":"starting_after","description":"\n\u003cp\u003eCursor for pagination (invoice ID)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::Invoices/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/invoices/:id","http_method":"GET","short_description":"Get a single invoice with details","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe invoice ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::PaymentMethods":{"doc_url":"/apipie/1.0/Payment::Stripe::PaymentMethods","id":"Payment::Stripe::PaymentMethods","api_url":"/api/v1","name":"Payment::Stripe::PaymentMethods","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::PaymentMethods/index","name":"index","apis":[{"api_url":"/api/v1/payment/stripe/payment_methods","http_method":"GET","short_description":"List saved payment methods","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::PaymentMethods/create","name":"create","apis":[{"api_url":"/api/v1/payment/stripe/payment_methods","http_method":"POST","short_description":"Create a SetupIntent for adding a new payment method","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::PaymentMethods/update","name":"update","apis":[{"api_url":"/api/v1/payment/stripe/payment_methods/:id","http_method":"PUT","short_description":"Set a payment method as default","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe payment method ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::PaymentMethods/destroy","name":"destroy","apis":[{"api_url":"/api/v1/payment/stripe/payment_methods/:id","http_method":"DELETE","short_description":"Remove a payment method","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe payment method ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Products":{"doc_url":"/apipie/1.0/Payment::Stripe::Products","id":"Payment::Stripe::Products","api_url":"/api/v1","name":"Payment::Stripe::Products","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Products/index","name":"index","apis":[{"api_url":"/api/v1/payment/stripe/products","http_method":"GET","short_description":"List all products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions","id":"Payment::Stripe::Subscriptions","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions/create","name":"create","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions","http_method":"POST","short_description":"Create a new subscription","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"price_id","full_name":"price_id","description":"\n\u003cp\u003eThe Price ID for the subscription\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eThe quantity of the subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Files::Duplications":{"doc_url":"/apipie/1.0/Storage::Files::Duplications","id":"Storage::Files::Duplications","api_url":"/api/v1","name":"Storage::Files::Duplications","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Files::Duplications/create","name":"create","apis":[{"api_url":"/api/v1/storage/files/:file_id/duplication","http_method":"POST","short_description":"Copy a storage file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eID of the file to copy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_type","full_name":"parent_type","description":"\n\u003cp\u003eType of the target parent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"\n\u003cp\u003eID of the target parent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003ePosition in the target parent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Files::Extractions":{"doc_url":"/apipie/1.0/Storage::Files::Extractions","id":"Storage::Files::Extractions","api_url":"/api/v1","name":"Storage::Files::Extractions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Files::Extractions/create","name":"create","apis":[{"api_url":"/api/v1/storage/files/:file_id/extraction","http_method":"POST","short_description":"Extract ZIP file contents","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eID of the ZIP file to extract\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_folder_id","full_name":"target_folder_id","description":"\n\u003cp\u003eID of folder to extract files to (defaults to same folder as ZIP file)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Files::Relocations":{"doc_url":"/apipie/1.0/Storage::Files::Relocations","id":"Storage::Files::Relocations","api_url":"/api/v1","name":"Storage::Files::Relocations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Files::Relocations/create","name":"create","apis":[{"api_url":"/api/v1/storage/files/:file_id/relocation","http_method":"POST","short_description":"Move a storage file","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eID of the file to move\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_type","full_name":"parent_type","description":"\n\u003cp\u003eType of the new parent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"\n\u003cp\u003eID of the new parent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003ePosition in the new parent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Storage::Folders::Relocations":{"doc_url":"/apipie/1.0/Storage::Folders::Relocations","id":"Storage::Folders::Relocations","api_url":"/api/v1","name":"Storage::Folders::Relocations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Storage::Folders::Relocations/create","name":"create","apis":[{"api_url":"/api/v1/storage/folders/:folder_id/relocation","http_method":"POST","short_description":"Move a storage folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"folder_id","full_name":"folder_id","description":"\n\u003cp\u003eID of the folder to move\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_type","full_name":"parent_type","description":"\n\u003cp\u003eType of the new parent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStorage::Folder\u003c/code\u003e, \u003ccode\u003eStorage::Category\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"\n\u003cp\u003eID of the new parent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003ePosition in the new parent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Common::Activities":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Activities","id":"Microsoft::Sharepoint::Common::Activities","api_url":"/api/v1","name":"Microsoft::Sharepoint::Common::Activities","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Activities/show","name":"show","apis":[{"api_url":"/api/v1/microsoft/sharepoint/common/:common_id/activities","http_method":"GET","short_description":"SharePoint: get activities for a file / folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"common_id","full_name":"common_id","description":"\n\u003cp\u003eID of the file/folder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Common::Duplications":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Duplications","id":"Microsoft::Sharepoint::Common::Duplications","api_url":"/api/v1","name":"Microsoft::Sharepoint::Common::Duplications","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Duplications/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/sharepoint/common/:common_id/duplication","http_method":"POST","short_description":"SharePoint: copy a file / folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"common_id","full_name":"common_id","description":"\n\u003cp\u003eID of the file/folder to copy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_parent_id","full_name":"new_parent_id","description":"\n\u003cp\u003eID of the new parent folder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eNew name for the copied file/folder\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Common::Relocations":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Relocations","id":"Microsoft::Sharepoint::Common::Relocations","api_url":"/api/v1","name":"Microsoft::Sharepoint::Common::Relocations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Relocations/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/sharepoint/common/:common_id/relocation","http_method":"POST","short_description":"SharePoint: move a file / folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"common_id","full_name":"common_id","description":"\n\u003cp\u003eID of the file/folder to move\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_parent_id","full_name":"new_parent_id","description":"\n\u003cp\u003eID of the new parent folder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Microsoft::Sharepoint::Common::Sharings":{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Sharings","id":"Microsoft::Sharepoint::Common::Sharings","api_url":"/api/v1","name":"Microsoft::Sharepoint::Common::Sharings","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Microsoft::Sharepoint::Common::Sharings/create","name":"create","apis":[{"api_url":"/api/v1/microsoft/sharepoint/common/:common_id/sharing","http_method":"POST","short_description":"SharePoint: create a sharing link for a file / folder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"common_id","full_name":"common_id","description":"\n\u003cp\u003eID of the file/folder to share\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::Cancellations":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Cancellations","id":"Payment::Stripe::Subscriptions::Cancellations","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::Cancellations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Cancellations/create","name":"create","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/cancellation","http_method":"POST","short_description":"Cancel running subscription at period end","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Cancellations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/cancellation","http_method":"DELETE","short_description":"Reactivate a canceled subscription","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::Coupons":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Coupons","id":"Payment::Stripe::Subscriptions::Coupons","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::Coupons","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Coupons/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/coupon","http_method":"GET","short_description":"Validate a promotion code","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"promotion_code","full_name":"promotion_code","description":"\n\u003cp\u003eThe promotion code to validate\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Coupons/create","name":"create","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/coupon","http_method":"POST","short_description":"Apply a promotion code to active subscription","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"promotion_code","full_name":"promotion_code","description":"\n\u003cp\u003eThe promotion code to apply\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true},{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Coupons/destroy","name":"destroy","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/coupon","http_method":"DELETE","short_description":"Remove coupon from active subscription","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::Current":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Current","id":"Payment::Stripe::Subscriptions::Current","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::Current","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Current/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/current","http_method":"GET","short_description":"Get full current subscription details","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::Plans":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Plans","id":"Payment::Stripe::Subscriptions::Plans","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::Plans","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Plans/update","name":"update","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/plan","http_method":"PUT","short_description":"Change the current subscription plan","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eThe quantity of the subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_price_id","full_name":"new_price_id","description":"\n\u003cp\u003eThe new Price ID for the subscription\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::Previews":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Previews","id":"Payment::Stripe::Subscriptions::Previews","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::Previews","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Previews/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/preview","http_method":"GET","short_description":"Preview cost of a plan or seat change","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"price_id","full_name":"price_id","description":"\n\u003cp\u003eThe new price ID to preview (optional)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eThe new seat count to preview (optional)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::SeatCounts":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::SeatCounts","id":"Payment::Stripe::Subscriptions::SeatCounts","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::SeatCounts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::SeatCounts/update","name":"update","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/seat_count","http_method":"PUT","short_description":"Increase the number of seats for a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eThe quantity of the subscription\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::UpcomingInvoices":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::UpcomingInvoices","id":"Payment::Stripe::Subscriptions::UpcomingInvoices","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::UpcomingInvoices","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::UpcomingInvoices/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/upcoming_invoice","http_method":"GET","short_description":"Preview the next upcoming invoice","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"Payment::Stripe::Subscriptions::Usages":{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Usages","id":"Payment::Stripe::Subscriptions::Usages","api_url":"/api/v1","name":"Payment::Stripe::Subscriptions::Usages","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/1.0/Payment::Stripe::Subscriptions::Usages/show","name":"show","apis":[{"api_url":"/api/v1/payment/stripe/subscriptions/usage","http_method":"GET","short_description":"Get seat usage summary","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":200,"description":"Success","metadata":null},{"code":400,"description":"Error","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"company_id","full_name":"company_id","description":"\n\u003cp\u003eThe ID of the company\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Authorization token","options":{"required":true}},{"name":"Language","description":"Language","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false}}}}