获取报价单明细对象描述接口
POST
https://open.fxiaoke.com/cgi/crm/v2/object/describe
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/object/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
"corpAccessToken": "${corpAccessToken}",
"corpId": "${corpId}",
"currentOpenUserId": "${currentOpenUserId}",
"includeDetail": true,
"apiName": "QuoteLinesObj"
}'
响应示例响应示例
{ "traceId": "E-O.fktest188.1453-1e250069620345bb", "data": { "describe": { "created_by": "-1000", "icon_index": 12, "api_name": "QuoteLinesObj", "display_name_r": "报价单明细", "fields": { "selling_price": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "销售单价", "index_name": "d_6", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1566400990743, "length": 12, "default_value": "$sales_price$*$extra_discount$", "label": "销售单价", "currency_unit": "¥", "api_name": "selling_price", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 0, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "lock_rule": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1528988047042, "description": "锁定规则", "is_unique": false, "default_value": "default_lock_rule", "rules": [], "label": "锁定规则", "type": "lock_rule", "is_need_convert": false, "is_required": false, "api_name": "lock_rule", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "锁定规则", "index_name": "s_2" }, "total_discount": { "describe_api_name": "QuoteLinesObj", "expression_type": "percentile", "default_is_expression": true, "is_index": true, "is_active": true, "create_time": 1572017351861, "is_unique": false, "default_value": "$selling_price$/$price$", "label": "总折扣", "type": "percentile", "default_to_zero": true, "is_required": false, "api_name": "total_discount", "define_type": "package", "is_single": false, "label_r": "总折扣", "is_index_field": false, "index_name": "d_7", "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 1, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "help_text": "记录系统和销售给予客户单品的总折扣,销售可以修改。如未修改默认公式时,修改该字段时,会自动计算出基于报价的销售单价(销售单价\u0003=价格*总折扣)和额外折扣(额外折扣\u0003=额外折扣\u0003=(报价-销售单价)/报价)" }, "quote_lines_specs": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1528988047046, "quote_field_type": "text", "is_unique": false, "label": "规格", "type": "quote", "quote_field": "product_id__r.product_spec", "default_to_zero": false, "is_required": false, "api_name": "quote_lines_specs", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "规格", "config": { "enable": 1 }, "index_name": "t_3", "help_text": "" }, "price_book_product_id": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": false, "create_time": 1528988047052, "is_unique": false, "label": "价目表产品", "target_api_name": "PriceBookProductObj", "type": "object_reference", "target_related_list_name": "price_book_product_quote_lines_list", "target_related_list_label": "报价单明细", "action_on_target_delete": "set_null", "is_required": true, "wheres": [ { "connector": "OR", "filters": [ { "value_type": 0, "operator": "EQ", "field_name": "product_status", "field_values": [ "1" ] } ] } ], "api_name": "price_book_product_id", "define_type": "package", "is_single": false, "label_r": "价目表产品", "is_index_field": false, "index_name": "s_4", "config": { "display": 0, "attrs": { "target_related_list_label": 1, "label": 1, "help_text": 1 } }, "help_text": "" }, "extra_discount_amount": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "额外折扣小计", "index_name": "d_8", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1566400990743, "length": 12, "default_value": "$sales_price$*$quantity$-$selling_price$*$quantity$", "label": "额外折扣小计", "currency_unit": "¥", "api_name": "extra_discount_amount", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 0, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "discount": { "describe_api_name": "QuoteLinesObj", "expression_type": "percentile", "default_is_expression": true, "is_index": true, "is_active": true, "create_time": 1528988047052, "is_unique": false, "default_value": "1", "label": "折扣", "type": "percentile", "default_to_zero": true, "is_required": false, "api_name": "discount", "define_type": "package", "is_single": false, "label_r": "折扣", "is_index_field": false, "index_name": "d_1", "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 1, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "help_text": "" }, "total_discount_amount": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "总折扣小计", "index_name": "d_9", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1572017351861, "length": 12, "default_value": "$price$*$quantity$-$selling_price$*$quantity$", "label": "总折扣小计", "currency_unit": "¥", "api_name": "total_discount_amount", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 0, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "lock_user": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1528988047052, "description": "加锁人", "is_unique": false, "label": "加锁人", "type": "employee", "is_need_convert": false, "is_required": false, "api_name": "lock_user", "define_type": "package", "is_index_field": false, "is_single": true, "label_r": "加锁人", "index_name": "a_1" }, "extend_obj_data_id": { "describe_api_name": "QuoteLinesObj", "default_is_expression": false, "is_index": false, "is_active": true, "create_time": 1528988047058, "pattern": "", "description": "extend_obj_data_id", "is_unique": false, "default_value": "", "label": "extend_obj_data_id", "type": "text", "default_to_zero": false, "is_required": false, "api_name": "extend_obj_data_id", "define_type": "system", "is_extend": false, "is_single": false, "label_r": "extend_obj_data_id", "is_index_field": false, "index_name": "t_1", "max_length": 100, "help_text": "" }, "extra_discount": { "describe_api_name": "QuoteLinesObj", "expression_type": "percentile", "default_is_expression": true, "is_index": true, "is_active": true, "create_time": 1566400990743, "is_unique": false, "default_value": "1", "label": "额外折扣", "type": "percentile", "default_to_zero": true, "is_required": false, "api_name": "extra_discount", "define_type": "package", "is_single": false, "label_r": "额外折扣小计", "is_index_field": false, "index_name": "d_10", "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 1, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "help_text": "" }, "is_deleted": { "describe_api_name": "QuoteLinesObj", "is_index": false, "create_time": 1523348165145, "is_unique": false, "description": "is_deleted", "default_value": false, "label": "is_deleted", "type": "true_or_false", "is_need_convert": false, "is_required": false, "api_name": "is_deleted", "define_type": "system", "index_name": "is_del" }, "price": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "价格", "index_name": "d_2", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1528988047058, "length": 12, "default_value": "$product_id__r.price$", "label": "价格(元)", "currency_unit": "¥", "api_name": "price", "is_index_field": false, "config": { "edit": 1, "attrs": { "default_value": 1, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "life_status_before_invalid": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1528988047058, "pattern": "", "description": "作废前生命状态", "is_unique": false, "label": "作废前生命状态", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "life_status_before_invalid", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "作废前生命状态", "index_name": "t_2", "max_length": 256 }, "product_id": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047058, "is_unique": false, "label": "产品名称", "target_api_name": "ProductObj", "type": "object_reference", "target_related_list_name": "product_quote_lines_list", "target_related_list_label": "报价单明细", "action_on_target_delete": "set_null", "is_required": true, "wheres": [ { "connector": "OR", "filters": [ { "value_type": 0, "operator": "EQ", "field_name": "product_status", "field_values": [ "1" ] } ] } ], "api_name": "product_id", "define_type": "package", "is_single": false, "label_r": "产品名称", "is_index_field": false, "index_name": "s_5", "config": { "edit": 1, "attrs": { "target_related_list_label": 1, "wheres": 1, "default_value": 1, "label": 1, "help_text": 1 } }, "help_text": "" }, "owner_department": { "describe_api_name": "QuoteLinesObj", "default_is_expression": false, "is_index": true, "is_active": true, "create_time": 1528988047059, "pattern": "", "is_unique": false, "default_value": "", "label": "负责人主属部门", "type": "text", "default_to_zero": false, "is_need_convert": false, "is_required": false, "api_name": "owner_department", "define_type": "package", "is_single": true, "label_r": "负责人所在部门", "is_index_field": false, "index_name": "owner_dept", "max_length": 100, "help_text": "" }, "out_owner": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1523348165145, "is_unique": false, "label": "外部负责人", "type": "employee", "is_need_convert": false, "is_required": false, "api_name": "out_owner", "define_type": "system", "is_single": true, "index_name": "o_owner", "config": { "display": 1 } }, "system_discount_amount": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "系统折扣小计", "index_name": "d_11", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1566400990743, "length": 12, "default_value": "$price$*$quantity$-$sales_price$*$quantity$", "label": "系统折扣小计", "currency_unit": "¥", "api_name": "system_discount_amount", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 0, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "quote_lines_unit": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1528988047059, "quote_field_type": "select_one", "is_unique": false, "label": "单位", "type": "quote", "quote_field": "product_id__r.unit", "is_required": false, "api_name": "quote_lines_unit", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "单位", "index_name": "s_7", "help_text": "" }, "owner": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047042, "is_unique": false, "label": "负责人", "type": "employee", "is_need_convert": false, "is_required": false, "api_name": "owner", "define_type": "package", "is_index_field": false, "is_single": true, "label_r": "负责人", "index_name": "owner", "help_text": "" }, "quantity": { "describe_api_name": "QuoteLinesObj", "expression_type": "number", "default_is_expression": false, "description": "", "is_unique": false, "type": "number", "decimal_places": 0, "default_to_zero": true, "is_required": true, "define_type": "package", "is_single": false, "label_r": "数量", "index_name": "d_3", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1528988047042, "length": 14, "default_value": "3", "label": "数量", "api_name": "quantity", "is_index_field": false, "config": { "add": 0, "edit": 1, "enable": 1, "display": 1, "remove": 0, "attrs": { "api_name": 0, "is_unique": 0, "default_value": 1, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "lock_status": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047046, "description": "锁定状态", "is_unique": false, "default_value": "0", "label": "锁定状态", "type": "select_one", "is_need_convert": false, "is_required": false, "api_name": "lock_status", "options": [ { "label": "未锁定", "value": "0" }, { "label": "锁定", "value": "1" } ], "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "锁定状态", "index_name": "s_3", "config": {} }, "last_modified_time": { "describe_api_name": "QuoteLinesObj", "is_index": true, "create_time": 1523348165145, "is_unique": false, "description": "last_modified_time", "label": "最后修改时间", "type": "date_time", "time_zone": "", "is_need_convert": false, "is_required": false, "api_name": "last_modified_time", "define_type": "system", "date_format": "yyyy-MM-dd HH:mm:ss", "index_name": "md_time" }, "create_time": { "describe_api_name": "QuoteLinesObj", "is_index": true, "create_time": 1523348165145, "is_unique": false, "description": "create_time", "label": "创建时间", "type": "date_time", "time_zone": "", "is_need_convert": false, "is_required": false, "api_name": "create_time", "define_type": "system", "date_format": "yyyy-MM-dd HH:mm:ss", "index_name": "crt_time" }, "life_status": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047052, "description": "生命状态", "is_unique": false, "default_value": "normal", "label": "生命状态", "type": "select_one", "is_need_convert": false, "is_required": false, "api_name": "life_status", "options": [ { "label": "未生效", "value": "ineffective" }, { "label": "审核中", "value": "under_review" }, { "label": "正常", "value": "normal" }, { "label": "变更中", "value": "in_change" }, { "label": "作废", "value": "invalid" } ], "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "生命状态", "index_name": "s_1", "config": {} }, "quote_id": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047052, "is_unique": false, "label": "报价单", "target_api_name": "QuoteObj", "type": "master_detail", "target_related_list_name": "quote_lines_list", "target_related_list_label": "报价单明细", "is_required": true, "api_name": "quote_id", "define_type": "package", "is_create_when_master_create": true, "is_single": false, "label_r": "报价单", "is_index_field": false, "is_required_when_master_create": false, "index_name": "s_6", "config": { "edit": 1, "attrs": { "label": 1, "is_required_when_master_create": 1 } }, "help_text": "" }, "sales_amount": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "销售金额小计", "index_name": "d_12", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1566400990743, "length": 12, "default_value": "$selling_price$*$quantity$", "label": "销售金额小计", "currency_unit": "¥", "api_name": "sales_amount", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 0, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "last_modified_by": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1523348165145, "is_unique": false, "label": "最后修改人", "type": "employee", "is_need_convert": true, "is_required": false, "api_name": "last_modified_by", "define_type": "system", "is_single": true, "index_name": "md_by" }, "out_tenant_id": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1523348165145, "pattern": "", "is_unique": false, "description": "out_tenant_id", "label": "外部企业", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "out_tenant_id", "define_type": "system", "index_name": "o_ei", "config": { "display": 0 }, "max_length": 200 }, "version": { "describe_api_name": "QuoteLinesObj", "is_index": false, "create_time": 1523348165145, "length": 8, "is_unique": false, "description": "version", "label": "version", "type": "number", "decimal_places": 0, "is_need_convert": false, "is_required": false, "api_name": "version", "define_type": "system", "index_name": "version", "round_mode": 4 }, "created_by": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1523348165145, "is_unique": false, "label": "创建人", "type": "employee", "is_need_convert": true, "is_required": false, "api_name": "created_by", "define_type": "system", "is_single": true, "index_name": "crt_by" }, "relevant_team": { "describe_api_name": "QuoteLinesObj", "embedded_fields": { "teamMemberEmployee": { "is_index": true, "is_need_convert": true, "is_required": false, "api_name": "teamMemberEmployee", "is_unique": false, "define_type": "package", "description": "成员员工", "label": "成员员工", "type": "employee", "is_single": true, "help_text": "成员员工" }, "teamMemberRole": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "teamMemberRole", "options": [ { "label": "负责人", "value": "1" }, { "label": "普通成员", "value": "4" } ], "is_unique": false, "define_type": "package", "description": "成员角色", "label": "成员角色", "type": "select_one", "help_text": "成员角色" }, "teamMemberPermissionType": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "teamMemberPermissionType", "options": [ { "label": "只读", "value": "1" }, { "label": "读写", "value": "2" } ], "is_unique": false, "define_type": "package", "description": "成员权限类型", "label": "成员权限类型", "type": "select_one", "help_text": "成员权限类型" } }, "is_index": true, "is_active": true, "create_time": 1528988047058, "is_unique": false, "label": "相关团队", "type": "embedded_object_list", "is_need_convert": false, "is_required": false, "api_name": "relevant_team", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "相关团队", "index_name": "a_team", "help_text": "相关团队" }, "record_type": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047058, "description": "record_type", "is_unique": false, "label": "业务类型", "type": "record_type", "is_need_convert": false, "is_required": true, "api_name": "record_type", "options": [ { "is_active": true, "api_name": "default__c", "description": "预设业务类型", "label": "预设业务类型" } ], "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "业务类型", "index_name": "r_type", "config": {} }, "data_own_department": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1523348165145, "is_unique": false, "label": "归属部门", "type": "department", "is_need_convert": false, "is_required": false, "api_name": "data_own_department", "define_type": "package", "is_single": true, "index_name": "data_owner_dept_id" }, "total_amount": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": false, "define_type": "package", "is_single": false, "label_r": "小计", "index_name": "d_5", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1528988047058, "length": 12, "default_value": "$sales_price$*$quantity$", "label": "报价小计", "currency_unit": "¥", "api_name": "total_amount", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 0, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "name": { "describe_api_name": "QuoteLinesObj", "is_index": true, "is_active": true, "create_time": 1528988047059, "prefix": "QuoteLinesCode-{yyyy}{mm}{dd}", "is_unique": true, "start_number": 1, "default_value": "01", "serial_number": 6, "label": "报价单明细编码", "type": "auto_number", "is_required": true, "api_name": "name", "define_type": "system", "postfix": "", "is_single": false, "label_r": "报价单明细编码", "is_index_field": false, "index_name": "name", "help_text": "" }, "sales_price": { "describe_api_name": "QuoteLinesObj", "expression_type": "currency", "default_is_expression": true, "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": true, "define_type": "package", "is_single": false, "label_r": "报价", "index_name": "d_4", "max_length": 14, "is_index": true, "is_active": true, "create_time": 1528988047059, "length": 12, "default_value": "$price$*$discount$", "label": "报价(元)", "currency_unit": "¥", "api_name": "sales_price", "is_index_field": false, "config": { "edit": 1, "enable": 1, "attrs": { "default_value": 1, "label": 1, "help_text": 1, "max_length": 1, "decimal_places": 1 } }, "round_mode": 4, "help_text": "" }, "order_by": { "describe_api_name": "QuoteLinesObj", "is_index": false, "create_time": 1523348165145, "length": 8, "is_unique": false, "description": "order_by", "label": "order_by", "type": "number", "decimal_places": 0, "is_need_convert": false, "is_required": false, "api_name": "order_by", "define_type": "system", "index_name": "l_by", "round_mode": 4 }, "_id": { "describe_api_name": "QuoteLinesObj", "is_index": false, "is_active": true, "create_time": 1523348165145, "pattern": "", "is_unique": false, "description": "_id", "label": "_id", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "_id", "define_type": "system", "index_name": "_id", "max_length": 200 } } }, "detailObjectDescribeList": [] }, "errorDescription": "success", "errorMessage": "success", "errorCode": 0 }
请求参数
Body 参数application/json