简要描述:

  • 合同下回款列表

请求URL:

  • /api/v2/contracts/:contract_id/received_payments

  • url请求参数说明
字段名 是否必填 描述
contract_id true 合同的id,替换掉url的:contract_id

请求方式:

  • GET

请求头:

返回示例:

正确时返回:

{
    "code": 0,
    "data": {
        "received_payments": [
            {
                "id": 1700010,
                "title": "第1期回款",
                "payment_type": "",
                "payment_type_mapped": "",
                "payment_type_i18n": "",
                "created_at": "2023-03-09 18:09",
                "amount": "10.0",
                "note": "",
                "receive_date": "2023-03-09",
                "received_types": "",
                "can_approve_received_payment": false,
                "received_types_mapped": "",
                "invoice_amount": "0.0",
                "approve_status": "approved",
                "approve_status_i18n": "已通过",
                "contract_id": 1900040,
                "contract_title": "傅斯年的合同",
                "customer_id": 1205643,
                "customer_name": "客户ldd零一",
                "step_can_approve": false,
                "can_revert_applying": false,
                "can_approve": true,
                "step": 0,
                "lock_status": false,
                "is_creator_self": false,
                "received_payment_plan": {
                    "id": 1900031,
                    "title": "第1期回款计划",
                    "period_name": "第1期",
                    "receive_stage": 1,
                    "payment_type": "",
                    "payment_type_i18n": "",
                    "created_at": "2023-03-09 18:09",
                    "amount": "10.0",
                    "note": "",
                    "receive_date": "2023-03-09",
                    "received_types": "0",
                    "paid_up": true,
                    "received_amount": "10.0",
                    "received_types_mapped": "",
                    "invoice_amount": "0.0",
                    "status": "done",
                    "status_i18n": "完成",
                    "is_deletable": false,
                    "contract_id": 1900040,
                    "contract_title": "傅斯年的合同",
                    "customer_id": 1205643,
                    "customer_name": "客户ldd零一",
                    "delay_num": 0,
                    "unreceived_amount": "0.0",
                    "lock_status": false
                },
                "user": {
                    "id": 5017926,
                    "email": "",
                    "created_at": "2022-07-15 18:10",
                    "name": "江慧琳211",
                    "organization_id": 5003867,
                    "phone": "15997295821",
                    "role_id": 18054,
                    "workflow_state": "organization_staff",
                    "job": "",
                    "tel": "",
                    "avatar_url": "https://lxcrm-staging.weiwenjia.com/assets/male_uc.jpg",
                    "department_name": "天王盖地虎",
                    "third_userid": null,
                    "third_dept_id": null,
                    "uid": 35895787
                },
                "receive_user": {
                    "id": 5017926,
                    "email": "",
                    "created_at": "2022-07-15 18:10",
                    "name": "江慧琳211",
                    "organization_id": 5003867,
                    "phone": "15997295821",
                    "role_id": 18054,
                    "workflow_state": "organization_staff",
                    "job": "",
                    "tel": "",
                    "avatar_url": "https://lxcrm-staging.weiwenjia.com/assets/male_uc.jpg",
                    "department_name": "天王盖地虎",
                    "third_userid": null,
                    "third_dept_id": null,
                    "uid": 35895787
                }
            }
        ],
        "column_list": [
            "receive_date",
            "amount",
            "customer",
            "contract",
            "received_payment_plan",
            "sn",
            "payment_type",
            "received_types",
            "overdue_status",
            "delay_num",
            "receive_user",
            "note",
            "submit_applying_at",
            "finish_approve_at",
            "approve_status",
            "created_at",
            "updated_at",
            "user",
            "approve_node"
        ],
        "total_count": 1,
        "per_page": 15,
        "page": 1
    }
}

错误时返回:


{
  "code": 100401,
  "data": null,
  "message": "你的帐号已在其他地方登录,本地已经下线"
}

回款记录接口文档

1. 响应结构

字段 类型 描述
code Integer 响应状态码,0 表示成功
data Object 响应数据主体,包含回款列表及分页信息

2. data 对象

字段 类型 描述
received_payments Array\ 回款记录列表
column_list Array\ 可用列字段标识列表,用于前端动态渲染表格列
total_count Integer 总记录数
per_page Integer 每页显示条数
page Integer 当前页码

3. received_payments 回款记录对象

字段 类型 描述
id Integer 回款记录唯一ID
title String 回款标题,如”第1期回款”
payment_type String 回款类型原始值
payment_type_mapped String 回款类型映射值
payment_type_i18n String 回款类型国际化显示文本
created_at String 创建时间,格式 YYYY-MM-DD HH:mm
amount String 回款金额
note String 备注信息
receive_date String 实际回款日期,格式 YYYY-MM-DD
received_types String 回款方式原始值
received_types_mapped String 回款方式映射值
invoice_amount String 开票金额
approve_status String 审批状态英文标识,如 approved
approve_status_i18n String 审批状态国际化显示文本,如”已通过”
contract_id Integer 关联合同ID
contract_title String 关联合同标题
customer_id Integer 关联客户ID
customer_name String 关联客户名称
can_approve_received_payment Boolean 当前用户是否可审批该回款
step_can_approve Boolean 当前审批节点是否可审批
can_revert_applying Boolean 是否可撤回审批申请
can_approve Boolean 是否具备审批权限
step Integer 当前审批步骤序号
lock_status Boolean 记录是否被锁定
is_creator_self Boolean 当前用户是否为该记录创建人
received_payment_plan Object 关联的回款计划详情,见下方 §4
user Object 记录创建人信息,见下方 §5
receive_user Object 回款负责人信息,结构同 §5

4. received_payment_plan 回款计划对象

字段 类型 描述
id Integer 回款计划唯一ID
title String 回款计划标题
period_name String 期数名称,如”第1期”
receive_stage Integer 回款阶段序号
payment_type String 计划回款类型原始值
payment_type_i18n String 计划回款类型国际化文本
created_at String 计划创建时间
amount String 计划回款金额
note String 计划备注
receive_date String 计划回款日期
received_types String 计划回款方式原始值
received_types_mapped String 计划回款方式映射值
paid_up Boolean 该期是否已结清
received_amount String 累计已收金额
unreceived_amount String 剩余未收金额
invoice_amount String 计划开票金额
status String 计划状态英文标识,如 done
status_i18n String 计划状态国际化文本,如”完成”
is_deletable Boolean 该计划是否可删除
contract_id Integer 关联合同ID
contract_title String 关联合同标题
customer_id Integer 关联客户ID
customer_name String 关联客户名称
delay_num Integer 逾期次数
lock_status Boolean 计划是否被锁定

5. user / receive_user 用户对象

字段 类型 描述
id Integer 用户ID
uid Integer 用户全局唯一UID
name String 用户姓名
email String 邮箱地址
phone String 手机号码
tel String 固定电话
job String 职位
avatar_url String 头像URL
department_name String 所属部门名称
organization_id Integer 所属组织ID
role_id Integer 角色ID
workflow_state String 工作流状态,如 organization_staff
third_userid String | Null 第三方平台用户ID
third_dept_id String | Null 第三方平台部门ID
created_at String 用户创建时间

6. column_list 可用列字段枚举

字段标识 描述
receive_date 回款日期
amount 回款金额
customer 客户
contract 合同
received_payment_plan 回款计划
sn 编号
payment_type 回款类型
received_types 回款方式
overdue_status 逾期状态
delay_num 逾期次数
receive_user 回款负责人
note 备注
submit_applying_at 提交审批时间
finish_approve_at 审批完成时间
approve_status 审批状态
created_at 创建时间
updated_at 更新时间
user 创建人
approve_node 审批节点

备注:

文档更新时间: 2026-07-28 15:31   作者:姜河