还款单列表接口
业务场景说明
查询单据列表接口,会返回单据的基本信息,可以根据条件来进行对单据的筛选,查询到单据列表后,如果需要更多详情,可以调用单据详情查询接口进行查询。
注意事项
- 该接口默认只会查询一年的单据(根据单据创建时间)
- 若传了其他时间参数,则创建参数非必填
- 若入参有多个时间参数,则以and关系查询符合条件的数据
- 反参数据以create时间倒序返回(最新的在最前面)
- 入参formStatus为DELETED时,返参的formStatus仍为删除前状态,且单据详情接口不支持查询DELETED状态的单据。
接口地址
/api/openapi/form/repayment
请求类型
POST
请求参数
参数说明
字段名 | 类型 | 是否有默认值 | 描述 |
---|---|---|---|
createdAtStart | Long | 是 | 根据单据的创建时间,返回(包括)之后的数据,如先点击暂存再提交,以暂存时间为准。 报销单特有:如果请求参数中没有创建时间、提单时间、审批通过时间、支付时间、和流程结束时间,系统会默认设置开始时间为一年前的0点0分 其他类:默认全部 |
createdAtEnd | Long | 是 | 根据单据的创建时间, 返回(不包括)之前的数据,如先点击暂存再提交,以暂存时间为准。 报销单特有:如果请求参数中没有创建时间、提单时间、审批通过时间、支付时间、和流程结束时间,系统会默认设置为当天的23点59分 其他类:默认全部 |
submittedAtStart | Long | 否 | 根据单据的提单时间,返回(包括)之后的数据 |
submittedAtEnd | Long | 否 | 根据单据的提单时间,返回(不包括)之前的数据 |
approvedAtStart | Long | 否 | 根据单据的审批通过时间,返回(包括)之后的数据,最后一个审批节点的通过时间 |
approvedAtEnd | Long | 否 | 根据单据的审批通过时间,返回(不包括)之前的数据,最后一个审批节点的通过时间 |
settledAtStart | Long | 否 | 根据单据的支付时间, 返回(包括)之后的数据,非标记支付时间,用户可以手动填写该时间。 |
settledAtEnd | Long | 否 | 根据单据的支付时间, 返回(不包括)之前的数据,非标记支付时间,用户可以手动填写该时间。 |
auditedAtStart | Long | 否 | 根据单据的审核时间, 返回(包括)之后的数据,最后审核节点的通过时间 |
auditedAtEnd | Long | 否 | 根据单据的审核时间, 返回(不包括)之前的数据,最后审核节点的通过时间 |
modifiedAtStart | Long | 否 | 根据单据的更新时间, 返回(不包括)之后的数据 |
modifiedAtEnd | Long | 否 | 根据单据的更新时间, 返回(不包括)之前的数据 |
formSubTypeBizCode | String | 否 | 单据小类业务编码, 可在每刻单据类型页面设置 |
formStatus | String | 是 | 单据状态, 可选值: APPROVING(审批中), AUDITING(审核中), SETTLEMENT(结算中), COMPLETED(已完成), DELETED(已删除), ABANDON(已作废), REJECTED(被驳回), SUBMIT_FAILED(提交失败), DRAFT(草稿) 默认值为所有未删除单据。 |
procInstEndTimeStart | Long | 否 | 流程结束时间,所有流程节点完成,包含支付、审核节点,返回(包括)之后的数据 |
procInstEndTimeEnd | Long | 否 | 流程结束时间,所有流程节点完成,包含支付、审核节点,返回(不包括)之前的数据 |
exportStatus | int | 否 | 导出状态 0-未导出,1-已导出 |
legalEntityBizCodes | List<string> | 否 | 公司抬头业务编码 |
formCodes | List<string> | 否 | 单据号列表 |
externalStates | List<string> | 否 | 需查询的外部状态码,默认为查全部,可选值:A-Z的枚举值;EMPTY |
fillUserList | List<string> | 否 | 填单人人工号列表,列表最大值为5 |
offset | Int | 是 | 当前页首条数据在所有数据中的偏移量,默认值0。例如:若pageSize=100,下一次offset=100,以此类推 |
pageSize | Int | 是 | 分页条数,默认值100,最大值100 |
参数示例
{
"createdAtStart": 1569859200000,
"createdAtEnd": 1569945600000,
"submittedAtStart": 1569859200000,
"submittedAtEnd": 1569945600000,
"approvedAtStart": 1569859200000,
"approvedAtEnd": 1569945600000,
"settledAtStart": 1569859200000,
"settledAtEnd": 1569945600000,
"auditedAtStart": 1569859200000,
"auditedAtEnd": 1569945600000,
"modifiedAtStart": 1569859200000,
"modifiedAtEnd": 1569945600000,
"formSubTypeBizCode": "FST0001",
"formStatus": "COMPLETED",
"procInstEndTimeStart": 1569859200000,
"procInstEndTimeEnd": 1569945600000,
"exportStatus": 0,
"legalEntityBizCodes": [
"ELC21102113BP29A8"
],
"formCodes": [
"FORMCODE001"
],
"externalStates": [
"A",
"EMPTY"
],
"fillUserList": [
"MK001"
],
"offset" : 0,
"pageSize" : 10
}
响应参数
参数说明
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
formSubTypeBizCode | String(100) | 是 | 单据小类编码 |
formSubTypeName | String(100) | 是 | 单据小类名称 |
formCode | String(50) | 是 | 单据号 |
formDataCode | String(25) | 是 | 单据内部编码 |
formName | String(500) | 是 | 单据名称 |
employeeName | String(100) | 是 | 提单人姓名 |
employeeId | String(100) | 是 | 提单人工号 |
amount | AmountInput | 是 | 报销金额 |
baseAmount | AmountInput | 是 | 本币金额 |
submittedAt | Long | 是 | 提单时间 |
formStatus | String(30) | 是 | 单据状态 |
statusText | String(30) | 是 | 单据状态描述 |
formType | String(30) | 是 | 单据类型,REIMBURSE报销单 |
approvedAt | Long | 否 | 审批通过时间,最后一个审批节点的通过时间 |
approvedAmount | AmountInput | 否 | 审批通过金额 |
approvedBaseAmount | AmountInput | 否 | 审批通过本币金额 |
legalEntityBizCode | String(100) | 是 | 公司抬头业务编码 |
legalEntityName | String(150) | 是 | 公司抬头名称 |
departmentBizCode | String(150) | 是 | 部门业务编码 |
departmentName | String(200) | 是 | 部门名称 |
procInstEndTime | Long | 否 | 流程结束时间,所有流程节点完成,包含支付、审核节点 |
tradingPartnerName | String(200) | 否 | 往来单位名称 |
tradingPartnerBizCode | String(80) | 否 | 往来单位业务编码 |
createdAt | Long | 是 | 单据创建时间 |
数据示例
{
"code": "ACK",
"message": "",
"data": {
"total": 1,
"offset": 0,
"pageSize": 100,
"list": [
{
"formSubTypeCode": "FT2212081SY3GSN4",
"formSubTypeBizCode": "HKD",
"formSubTypeNameZh": "还款单",
"formSubTypeNameEn": null,
"formSubTypeName": "还款单",
"formCode": "MK23040123",
"formDataCode": "RP21139634434081814",
"formName": "1111",
"requestUserCode": "UI2012221C97WQDC",
"employeeName": "MK001",
"employeeId": "MK001",
"amount": {
"currency": "CNY",
"amount": 1.000000
},
"baseAmount": {
"currency": "CNY",
"amount": 1.000000
},
"departmentBizCode": "MK001",
"departmentCode": "DI200722Y35YA3Z",
"departmentName": "研发部",
"submittedAt": 1682582563615,
"formStatus": "APPROVING",
"statusText": "审批中",
"formType": "REPAYMENT",
"acceptCcy": "CNY",
"baseCcy": "CNY",
"allocated": false,
"multiplePayeeFlag": false,
"paymentAmount": {
"currency": "CNY",
"amount": null
},
"paymentBaseAmount": {
"currency": "CNY",
"amount": null
},
"legalEntityCode": "ELC210924139XVHQ8",
"legalEntityBizCode": "ELC210924139XVHQ8",
"legalEntityName": "公司抬头名称",
"departmentHeirCode": null,
"settledAt": null,
"approvedAt": null,
"auditedAt": null,
"procInstEndTime": null,
"createdAt": 1682582563241,
"updatedAt": 1682582563885,
"tradingPartnerCode": "TRP22031418STF2M8",
"tradingPartnerBizCode": "7045",
"tradingPartnerName": "往来单位名称",
"approvedAmount": {
"currency": "CNY",
"amount": 1.000000
},
"approvedBaseAmount": {
"currency": "CNY",
"amount": 1.000000
},
"exportStatus": null,
"exportComments": null,
"externalVoucherCodes": null,
"externalState": null,
"overdueDeduction": false
}
]
},
"errorCode": null,
"success": true
}