获取回款计划对象描述接口
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": "PaymentPlanObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-8ab910b1c5bf4744",
"data": {
"describe": {
"created_by": "-1000",
"api_name": "PaymentPlanObj",
"display_name_r": "回款计划",
"fields": {
"lock_rule": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1526647805034,
"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_1"
},
"approve_employee_id": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805049,
"description": "当前审批人",
"is_unique": false,
"label": "当前审批人",
"type": "employee",
"is_required": false,
"api_name": "approve_employee_id",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "当前审批人",
"index_name": "a_1"
},
"remark": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805048,
"pattern": "",
"description": "备注",
"is_unique": false,
"label": "备注",
"type": "long_text",
"is_required": false,
"api_name": "remark",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "备注",
"config": {
"edit": 1,
"enable": 1,
"remove": 1,
"attrs": {
"label": 1
}
},
"index_name": "t_2",
"max_length": 2000
},
"lock_user": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1526647805034,
"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_2"
},
"extend_obj_data_id": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805046,
"pattern": "",
"description": "extend_obj_data_id",
"is_unique": false,
"label": "extend_obj_data_id",
"type": "text",
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "extend_obj_data_id",
"index_name": "t_3",
"max_length": 100
},
"is_deleted": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"create_time": 1606747091352,
"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"
},
"attachment": {
"describe_api_name": "PaymentPlanObj",
"file_amount_limit": 1,
"is_index": true,
"is_active": true,
"create_time": 1526647805047,
"description": "附件",
"is_unique": false,
"label": "附件",
"type": "file_attachment",
"file_size_limit": 10485760,
"is_required": false,
"api_name": "attachment",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "附件",
"config": {
"edit": 1,
"enable": 1,
"remove": 1,
"attrs": {
"file_amount_limit": 1,
"label": 1
}
},
"index_name": "a_3",
"support_file_types": []
},
"remind_time": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805043,
"length": 14,
"description": "提前几日提醒",
"is_unique": false,
"label": "提前几日提醒",
"type": "number",
"decimal_places": 0,
"is_required": false,
"api_name": "remind_time",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "提前几日提醒",
"config": {
"edit": 1,
"enable": 1,
"remove": 1,
"attrs": {
"label": 1
}
},
"index_name": "d_1",
"round_mode": 4
},
"actual_payment_amount": {
"describe_api_name": "PaymentPlanObj",
"return_type": "number",
"description": "实际回款金额（元）",
"is_unique": false,
"type": "count",
"decimal_places": 2,
"sub_object_describe_apiname": "OrderPaymentObj",
"is_required": false,
"wheres": [
{
"connector": "OR",
"filters": [
{
"value_type": 0,
"operator": "EQ",
"field_name": "life_status",
"field_values": [
"normal"
]
}
]
},
{
"connector": "OR",
"filters": [
{
"value_type": 0,
"operator": "EQ",
"field_name": "life_status",
"field_values": [
"in_change"
]
}
]
}
],
"define_type": "package",
"is_single": false,
"label_r": "实际回款金额（元）",
"index_name": "d_3",
"field_api_name": "payment_plan_id",
"is_index": true,
"is_active": true,
"create_time": 1526647805041,
"count_type": "sum",
"count_field_api_name": "payment_amount",
"label": "实际回款金额（元）",
"api_name": "actual_payment_amount",
"count_field_type": "currency",
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"is_readonly": 0,
"is_required": 0,
"label": 1
}
}
},
"life_status_before_invalid": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1526647805034,
"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_1",
"max_length": 256
},
"order_amount": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1526647805037,
"quote_field_type": "currency",
"description": "销售订单金额",
"is_unique": false,
"label": "销售订单金额",
"type": "quote",
"quote_field": "order_id__r.order_amount",
"is_required": false,
"api_name": "order_amount",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "销售订单金额",
"config": {
"edit": 1,
"attrs": {
"is_required": 0,
"label": 1
}
},
"index_name": "d_4"
},
"plan_payment_status": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805042,
"description": "状态",
"is_unique": false,
"label": "状态",
"type": "select_one",
"is_required": false,
"api_name": "plan_payment_status",
"options": [
{
"not_usable": false,
"label": "未完成",
"value": "incomplete",
"config": {}
},
{
"not_usable": false,
"label": "已完成",
"value": "completed",
"config": {}
},
{
"not_usable": false,
"label": "已逾期",
"value": "overdue",
"config": {}
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "状态",
"config": {
"add": 1,
"edit": 1,
"attrs": {
"options": 1
}
},
"index_name": "s_6"
},
"owner_department": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805045,
"pattern": "",
"description": "负责人所在部门",
"is_unique": false,
"label": "负责人所在部门",
"type": "text",
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"label_r": "负责人所在部门",
"index_name": "owner_dept",
"max_length": 255
},
"out_owner": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1606747091352,
"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
}
},
"owner": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805044,
"description": "负责人",
"is_unique": false,
"label": "负责人",
"type": "employee",
"is_required": true,
"api_name": "owner",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"label_r": "负责人",
"index_name": "owner"
},
"plan_payment_method": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805040,
"description": "计划回款方式",
"is_unique": false,
"label": "计划回款方式",
"type": "select_one",
"is_required": false,
"api_name": "plan_payment_method",
"options": [
{
"not_usable": false,
"label": "支票",
"value": "1",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "现金",
"value": "2",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "邮政汇款",
"value": "3",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "电汇",
"value": "4",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "网上转账",
"value": "5",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "支付宝",
"value": "6",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "微信支付",
"value": "7",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "在线支付",
"value": "9",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "线下支付",
"value": "10",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "计划回款方式",
"config": {
"add": 1,
"edit": 1,
"enable": 1,
"display": 1,
"remove": 1,
"attrs": {
"api_name": 0,
"options": 1,
"is_unique": 0,
"default_value": 0,
"label": 0,
"help_text": 0
}
},
"index_name": "s_2"
},
"plan_payment_amount": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805038,
"length": 18,
"description": "计划回款金额（元）",
"is_unique": false,
"label": "计划回款金额（元）",
"type": "currency",
"currency_unit": "￥",
"decimal_places": 2,
"is_required": true,
"api_name": "plan_payment_amount",
"define_type": "package",
"is_single": false,
"label_r": "计划回款金额（元）",
"is_index_field": false,
"index_name": "d_2",
"config": {
"edit": 1,
"attrs": {
"is_required": 0,
"label": 1
}
},
"round_mode": 4
},
"lock_status": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805034,
"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": "PaymentPlanObj",
"is_index": true,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"is_index": true,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805034,
"description": "生命状态",
"is_unique": false,
"default_value": "normal",
"label": "生命状态",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"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_4",
"config": {}
},
"last_modified_by": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"is_index": false,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"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,
"index_name": "stringList_3",
"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",
"index_name": "string_5",
"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",
"index_name": "string_6",
"help_text": "成员权限类型"
}
},
"is_index": true,
"is_active": true,
"create_time": 1526647805051,
"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": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805052,
"description": "record_type",
"is_unique": false,
"label": "业务类型",
"type": "record_type",
"is_need_convert": false,
"is_required": false,
"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": {}
},
"account_id": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805035,
"description": "客户名称",
"is_unique": false,
"label": "客户名称",
"target_api_name": "AccountObj",
"type": "object_reference",
"target_related_list_name": "related_list_a_payment_plan",
"target_related_list_label": "回款计划",
"action_on_target_delete": "set_null",
"is_required": true,
"wheres": [],
"api_name": "account_id",
"define_type": "package",
"is_single": false,
"label_r": "客户名称",
"is_index_field": true,
"index_name": "s_7",
"config": {
"edit": 1,
"attrs": {
"wheres": 1,
"is_required": 0,
"label": 1,
"help_text": 1
}
},
"cascade_detail_api_name": {
"PaymentPlanObj": [
"order_id"
]
}
},
"data_own_department": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1606747091352,
"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"
},
"plan_payment_time": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805039,
"description": "计划回款日期",
"is_unique": false,
"label": "计划回款日期",
"time_zone": "GMT+8",
"type": "date",
"is_required": true,
"api_name": "plan_payment_time",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_index_field": false,
"is_single": false,
"label_r": "计划回款日期",
"config": {
"edit": 1,
"attrs": {
"is_required": 0,
"label": 1
}
},
"index_name": "l_1"
},
"name": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1545708948450,
"prefix": "{yyyy}{mm}{dd}-",
"description": "回款计划编号",
"is_unique": false,
"serial_number": 6,
"start_number": 1,
"label": "回款计划编号",
"type": "auto_number",
"is_required": true,
"api_name": "name",
"define_type": "system",
"postfix": "",
"is_index_field": false,
"is_single": false,
"label_r": "回款计划编号",
"index_name": "name"
},
"order_by": {
"describe_api_name": "PaymentPlanObj",
"is_index": false,
"create_time": 1606747091352,
"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": "PaymentPlanObj",
"is_index": false,
"is_active": true,
"create_time": 1606747091352,
"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
},
"order_id": {
"describe_api_name": "PaymentPlanObj",
"is_index": true,
"is_active": true,
"create_time": 1526647805036,
"description": "销售订单编号",
"is_unique": false,
"label": "销售订单编号",
"target_api_name": "SalesOrderObj",
"type": "object_reference",
"target_related_list_name": "related_list_o_payment_plan",
"target_related_list_label": "回款计划",
"action_on_target_delete": "set_null",
"is_required": true,
"wheres": [
{
"connector": "OR",
"filters": [
{
"value_type": 2,
"operator": "EQ",
"field_name": "account_id",
"field_values": [
"$account_id$"
]
}
]
}
],
"api_name": "order_id",
"define_type": "package",
"cascade_parent_api_name": [
"account_id"
],
"is_single": false,
"label_r": "销售订单编号",
"is_index_field": true,
"index_name": "s_8",
"config": {
"edit": 1,
"attrs": {
"is_required": 0,
"label": 1,
"help_text": 1
}
},
"new_cascade_parent_api_name": {
"PaymentPlanObj": [
"account_id"
]
}
}
}
},
"detailObjectDescribeList": []
},
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0
}请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-02-23 07:42:53