获取预存款对象描述接口
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": "PrepayDetailObj"
}'
响应示例响应示例
{
"errorCode": 0,
"errorMessage": "success",
"data": {
"describe": {
"fields": {
"customer_id": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126769,
"is_unique": false,
"label": "客户名称",
"target_api_name": "AccountObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_prepay_customer",
"target_related_list_label": "预存款",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": true,
"api_name": "customer_id",
"define_type": "package",
"is_extend": false,
"is_index_field": true,
"is_single": false,
"index_name": "s_8"
},
"customer_account_id": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126770,
"is_unique": false,
"label": "客户账户",
"target_api_name": "CustomerAccountObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_prepay_customer_account",
"target_related_list_label": "预存款",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": true,
"api_name": "customer_account_id",
"define_type": "package",
"is_extend": false,
"is_index_field": true,
"is_single": false,
"index_name": "s_9"
},
"order_payment_id": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126758,
"is_unique": false,
"label": "回款明细编号",
"target_api_name": "OrderPaymentObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_prepay_order_payment",
"target_related_list_label": "预存款",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "order_payment_id",
"define_type": "package",
"is_extend": false,
"is_index_field": true,
"is_single": false,
"index_name": "s_1"
},
"refund_id": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126762,
"is_unique": false,
"label": "退款编号",
"target_api_name": "RefundObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_prepay_refund",
"target_related_list_label": "预存款",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "refund_id",
"define_type": "package",
"is_extend": false,
"is_index_field": true,
"is_single": false,
"index_name": "s_5"
},
"name": {
"describe_api_name": "PrepayDetailObj",
"prefix": "PT{yyyy}-{mm}-{dd}_",
"is_unique": true,
"start_number": 1,
"type": "auto_number",
"is_required": true,
"define_type": "system",
"postfix": "",
"is_extend": false,
"is_single": false,
"index_name": "name",
"is_index": true,
"is_active": true,
"create_time": 1595318126745,
"default_value": "01",
"serial_number": 4,
"label": "明细编码",
"condition": "NONE",
"is_need_convert": false,
"api_name": "name",
"is_index_field": false
},
"amount": {
"describe_api_name": "PrepayDetailObj",
"is_unique": false,
"type": "currency",
"decimal_places": 2,
"default_to_zero": true,
"is_required": true,
"define_type": "package",
"is_extend": false,
"is_single": false,
"index_name": "d_1",
"max_length": 14,
"is_index": true,
"is_active": true,
"create_time": 1595318126760,
"length": 12,
"label": "金额(元)",
"currency_unit": "¥",
"is_need_convert": false,
"api_name": "amount",
"is_index_field": false,
"round_mode": 4
},
"transaction_time": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126767,
"is_unique": false,
"label": "交易时间",
"time_zone": "GMT+8",
"type": "date_time",
"is_need_convert": false,
"is_required": true,
"api_name": "transaction_time",
"define_type": "package",
"date_format": "yyyy-MM-dd HH:mm:ss",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "l_1"
},
"relevant_team": {
"describe_api_name": "PrepayDetailObj",
"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": 1595318126771,
"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,
"index_name": "a_team",
"help_text": "相关团队"
},
"owner": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126759,
"is_unique": false,
"label": "负责人",
"type": "employee",
"is_need_convert": false,
"is_required": true,
"api_name": "owner",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": true,
"index_name": "owner"
},
"lock_user": {
"describe_api_name": "PrepayDetailObj",
"is_index": false,
"is_active": true,
"create_time": 1595318126752,
"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,
"index_name": "a_1"
},
"attach": {
"describe_api_name": "PrepayDetailObj",
"file_amount_limit": 10,
"is_index": false,
"is_active": true,
"create_time": 1595318126768,
"is_unique": false,
"label": "附件",
"type": "file_attachment",
"file_size_limit": 10485760,
"is_need_convert": false,
"is_required": false,
"api_name": "attach",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "a_2",
"support_file_types": []
},
"lock_rule": {
"describe_api_name": "PrepayDetailObj",
"is_index": false,
"is_active": true,
"create_time": 1595318126751,
"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,
"index_name": "s_2"
},
"remark": {
"describe_api_name": "PrepayDetailObj",
"is_index": false,
"is_active": true,
"create_time": 1595318126743,
"pattern": "",
"is_unique": false,
"label": "备注",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "remark",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "t_1",
"max_length": 1000
},
"record_type": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126763,
"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",
"label": "支出"
},
{
"is_active": true,
"api_name": "income_record_type__c",
"label": "收入"
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "r_type",
"config": {}
},
"lock_status": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126752,
"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,
"index_name": "s_3",
"config": {}
},
"life_status": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126761,
"is_unique": false,
"default_value": "normal",
"label": "生命状态",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "life_status",
"options": [
{
"not_usable": false,
"label": "未生效",
"value": "ineffective"
},
{
"not_usable": false,
"label": "审核中",
"value": "under_review"
},
{
"not_usable": false,
"label": "正常",
"value": "normal"
},
{
"not_usable": false,
"label": "变更中",
"value": "in_change"
},
{
"not_usable": false,
"label": "作废",
"value": "invalid"
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "s_4",
"config": {},
"help_text": "由回款/退款关联产生的预存款记录,不走审批流,它的状态随回款/退款的状态变化而变化。"
},
"income_type": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126764,
"is_unique": false,
"label": "收入类型",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "income_type",
"options": [
{
"not_usable": false,
"label": "线上充值",
"value": "1"
},
{
"not_usable": false,
"label": "订单退款",
"value": "3"
},
{
"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": "8",
"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
}
},
{
"not_usable": false,
"label": "其他",
"value": "other",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {
"add": 1,
"edit": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0,
"options": 1,
"default_value": 1
}
},
"index_name": "s_6"
},
"outcome_type": {
"describe_api_name": "PrepayDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1595318126766,
"is_unique": false,
"label": "支出类型",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "outcome_type",
"options": [
{
"not_usable": false,
"label": "抵扣订单",
"value": "1"
},
{
"not_usable": false,
"label": "手动扣减",
"value": "3",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "其他",
"value": "other",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {
"add": 1,
"edit": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0,
"options": 1,
"default_value": 1
}
},
"index_name": "s_7"
},
"extend_obj_data_id": {
"describe_api_name": "PrepayDetailObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595318126745,
"pattern": "",
"is_unique": false,
"label": "extend_obj_data_id",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "t_2",
"max_length": 256
},
"life_status_before_invalid": {
"describe_api_name": "PrepayDetailObj",
"is_index": false,
"is_active": true,
"create_time": 1595318126752,
"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,
"index_name": "t_3",
"max_length": 256
},
"online_charge_no": {
"describe_api_name": "PrepayDetailObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595318126742,
"pattern": "",
"is_unique": false,
"label": "支付流水号",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "online_charge_no",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "t_4",
"max_length": 100
},
"owner_department": {
"describe_api_name": "PrepayDetailObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595318126745,
"pattern": "",
"is_unique": false,
"label": "负责人所在部门",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "owner_dept",
"max_length": 256
},
"_id": {
"type": "text",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"max_length": 200,
"pattern": "",
"label": "_id",
"is_active": true,
"api_name": "_id",
"description": "_id",
"index_name": "_id",
"create_time": 1595318126837
},
"version": {
"type": "number",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"round_mode": 4,
"length": 8,
"decimal_places": 0,
"label": "version",
"api_name": "version",
"description": "version",
"index_name": "version",
"create_time": 1595318126837
},
"created_by": {
"type": "employee",
"define_type": "system",
"is_index": true,
"is_need_convert": true,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "created_by",
"label": "创建人",
"is_active": true,
"index_name": "crt_by",
"create_time": 1595318126837
},
"last_modified_by": {
"type": "employee",
"define_type": "system",
"is_index": true,
"is_need_convert": true,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "last_modified_by",
"is_active": true,
"index_name": "md_by",
"label": "最后修改人",
"create_time": 1595318126837
},
"create_time": {
"type": "date_time",
"define_type": "system",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"time_zone": "",
"date_format": "yyyy-MM-dd HH:mm:ss",
"label": "创建时间",
"api_name": "create_time",
"description": "create_time",
"index_name": "crt_time",
"create_time": 1595318126837
},
"last_modified_time": {
"type": "date_time",
"define_type": "system",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"time_zone": "",
"date_format": "yyyy-MM-dd HH:mm:ss",
"label": "最后修改时间",
"api_name": "last_modified_time",
"description": "last_modified_time",
"index_name": "md_time",
"create_time": 1595318126837
},
"is_deleted": {
"type": "true_or_false",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"label": "is_deleted",
"api_name": "is_deleted",
"description": "is_deleted",
"default_value": false,
"index_name": "is_del",
"create_time": 1595318126837
},
"out_tenant_id": {
"type": "text",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"max_length": 200,
"pattern": "",
"label": "外部企业",
"is_active": true,
"api_name": "out_tenant_id",
"description": "out_tenant_id",
"index_name": "o_ei",
"create_time": 1595318126837,
"config": {
"display": 0
}
},
"out_owner": {
"type": "employee",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "out_owner",
"index_name": "o_owner",
"label": "外部负责人",
"is_active": true,
"config": {
"display": 1
},
"create_time": 1595318126837
},
"data_own_department": {
"type": "department",
"define_type": "package",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "data_own_department",
"label": "归属部门",
"is_active": true,
"index_name": "data_owner_dept_id",
"create_time": 1595318126837
},
"order_by": {
"type": "number",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"round_mode": 4,
"length": 8,
"decimal_places": 0,
"label": "order_by",
"api_name": "order_by",
"description": "order_by",
"index_name": "l_by",
"create_time": 1595318126837
}
},
"api_name": "PrepayDetailObj"
},
"detailObjectDescribeList": []
},
"traceId": "E-O.80736.1000-146c8bf970904771-00302"
}
请求参数
Body 参数application/json