文档目录

申请单列表接口

说明

询单据列表接口，会返回单据的基本信息，可以根据条件来进行对单据的筛选，查询到单据列表。

注意事项

该接口默认只会查询一年的单据
若传了其他时间参数，则创建参数非必填
若入参有多个时间参数，则以and关系查询符合条件的数据
反参数据以create时间倒序返回（最新的在最前面）

接口地址

/api/openapi/form/preconsume

请求类型

POST

请求参数

参数说明

字段名称	字段类型	是否必填	字段说明
createdAtStart	Date	是	根据单据的创建时间，返回（包括）之后的数据，如先点击暂存再提交，以暂存时间为准。如果请求参数中没有创建时间、提单时间、审批通过时间、支付时间、和流程结束时间，系统会默认设置开始时间为一年前的0点0分
createdAtEnd	Date	是	根据单据的创建时间，返回（不包括）之前的数据，如先点击暂存再提交，以暂存时间为准。如果请求参数中没有创建时间、提单时间、审批通过时间、支付时间、和流程结束时间，系统会默认设置为当天的23点59分
submittedAtStart	Date	否	根据单据的提单时间，返回（包括）之后的数据
submittedAtEnd	Date	否	根据单据的提单时间，返回（不包括）之前的数据
approvedAtStart	Date	否	根据单据的审批通过时间，返回（包括）之后的数据，最后一个审批节点的通过时间
approvedAtEnd	Date	否	根据单据的审批通过时间，返回（不包括）之前的数据，最后一个审批节点的通过时间
formSubTypeBizCode	String(25)	否	单据小类业务编码, 可在每刻单据类型页面设置
formStatus	String(25)	否	单据状态,默认值为所有未删除单据。可选值: APPROVING（审批中）, AUDITING（审核中）, COMPLETED（已完成）, DELETED（已删除）, ABANDON（已作废）, REJECTED（被驳回）， SUBMIT_FAILED（提交失败）， DRAFT（草稿）, CHANGED（已变更）, CLOSED（已停用）默认值为所有未删除单据。
procInstEndTimeStart	Date	否	流程结束时间，所有流程节点完成，包含支付、审核节点，返回（包括）之后的数据
procInstEndTimeEnd	Date	否	流程结束时间，所有流程节点完成，包含支付、审核节点，返回（不包括）之前的数据
exportStatus	int	否	导出状态 0-未导出，1-已导出
legalEntityBizCodes	List<String>	否	公司抬头业务编码
formCodes	List<String>	否	单据号列表
externalStates	List<String>	否	需查询的外部状态码，默认为查全部，可选值：A-Z的枚举值； EMPTY
offset	int	否	当前页首条数据在所有数据中的偏移量，默认值0。例如：若pageSize=100，下一次offset=100，以此类推
pageSize	int	否	分页条数，默认值100，最大值100

参数样例

{
  "createdAtStart": 1569859200000,
  "createdAtEnd": 1569945600000,
  "submittedAtStart": 1569859200000,
  "submittedAtEnd" : 1569945600000,
  "approvedAtStart": 1569859200000,
  "approvedAtEnd" : 1569945600000,
  "auditedAtStart": 1569859200000,
  "auditedAtEnd" : 1569945600000,
  "formSubTypeBizCode" : "FST0001",
  "formStatus" : "COMPLETED",
  "formCodes": ["FORMCODE001"],
  "externalStates": ["A", "Z"],
  "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	是	申请金额
submittedAt	Long	是	提单时间
formStatus	String(30)	是	单据状态
statusText	String(30)	是	单据状态描述
formType	String(30)	是	单据类型，REIMBURSE报销单
paymentAmount	AmountInput	是	应付金额
approvedAt	Long	否	审批通过时间，最后一个审批节点的通过时间
approvedAmount	AmountInput	否	审批通过金额
legalEntityBizCode	String(100)	是	公司抬头业务编码
legalEntityName	String(150)	是	公司抬头名称
departmentBizCode	String(150)	是	部门业务编码
departmentName	String(200)	是	部门名称
procInstEndTime	Long	否	流程结束时间，所有流程节点完成，包含支付、审核节点
tradingPartnerName	String(200)	否	往来单位名称
tradingPartnerBizCode	String(80)	否	往来单位业务编码
exportStatus	int	否	导出状态 0-未导出、1-已导出
exportComments	String(1000)	否	导出备注
externalVoucherCodes	String(500)	否	使用单据标记接口写入的外部凭证编码
externalState	String(5)	否	外部状态,A-Z的枚举值
travelPartnerInfo	List<TravelPartner>	否	参与人
createdAt	Long	是	单据创建时间

参数样例

正常响应参数示例

{
"code": "ACK", 
"message": "成功",
"data":{ 
   "total": 1000,
   "offset": 100,
   "pageSize":1,
   "list": [{
      "formSubTypeBizCode": "BXD001",
      "formSubTypeName": "申请事由",
      "formCode": "MK19099001",
      "formDataCode": "PC1909251U9B2K1S",
      "formName": "申请单导入Junit",
      "employeeName": "张三",
      "employeeId": "emp001",
      "departmentBizCode": "DI1803221E22UHXF",
      "departmentName": "杭州每时每刻有限公司",
      "submittedAt": 1569410436063,
      "formStatus": "APPROVING",
      "statusText": "审批中",
      "formType": "PRECONSUME",
      "allocated": false,
      "exportStatus": 1,
      "exportComments": "导出备注",
      "externalVoucherCodes": "CODE01,CODE02",
      "externalState": "A",
      "multiplePayeeFlag": false,
      "paymentAmount": {"amount": 1200.00, "currency": "USD"},
      "legalEntityBizCode": null,
      "legalEntityName": null,
      "settledAt": 1569410436063,
      "approvedAt": 1569410436063
   }]
}
}

修改记录

2023-02-08  新增申请单列表接口文档

results matching ""

No results matching ""

results matching ""

No results matching ""