分期单列表接口

业务场景说明

查询单据列表接口,会返回单据的基本信息,可以根据条件来进行对单据的筛选,查询到单据列表后,如果需要更多详情,可以调用单据详情查询接口进行查询。

注意事项

  1. 该接口默认只会查询一年的单据(根据单据创建时间)
  2. 若传了其他时间参数,则创建参数非必填
  3. 若入参有多个时间参数,则以and关系查询符合条件的数据
  4. 反参数据以create时间倒序返回(最新的在最前面)
  5. 入参formStatus为DELETED时,返参的formStatus仍为删除前状态,且单据详情接口不支持查询DELETED状态的单据。

接口地址

/api/openapi/form/payment

请求类型

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 根据单据的审核时间, 返回(不包括)之前的数据,最后审核节点的通过时间
formStatus String(25) 单据状态,默认值为所有未删除单据。 可选值:
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
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,
  "formStatus": "COMPLETED",
  "procInstEndTimeStart": 1569859200000,
  "procInstEndTimeEnd": 1569945600000,
  "exportStatus": 0,
  "legalEntityBizCodes": [
    "ELC21102113BP29A8"
  ],
  "formCodes": [
    "FORMCODE001"
  ],
  "externalStates": [
    "A",
    "EMPTY"
  ],
  "pageNo": 1,
  "pageSize": 10
}

响应参数说明

五种类型的表单,都会有一个基本的数据字段结构,在基本的数据结构之外,对于不同表单,会有不同的额外参数。下方表格中,描述了所有的参数,如果某表单具有该字段,则会使用[●] 来标识。 其中AmountInput为金额类型,该类型的json格式可以查看数据类型说明。

字段名称 字段类型 是否必填 字段说明
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) 部门名称
settledAt Long 支付时间,非标记支付时间,用户可以手动填写该时间。
auditedAt Long 审核时间,最后一个审核节点的通过时间
procInstEndTime Long 流程结束时间,所有流程节点完成,包含支付、审核节点
waitPayAmount AmountInput 待支付金额
tradingPartnerName String(200) 往来单位名称
tradingPartnerBizCode String(80) 往来单位业务编码
exportStatus int 导出状态 0-未导出、1-已导出
exportComments String(1000) 导出备注
externalVoucherCodes String(500) 使用单据标记接口写入的外部凭证编码
externalState String(5) 外部状态,A-Z的枚举值
createdAt Long 单据创建时间

响应数据示例

{

  "code": "ACK",  
  "message": "成功",  
  "data":{
    "total": 1000,
    "offset": 100,
    "pageSize":1,
    "list": [{
      "formSubTypeBizCode": "BXD001",
      "formSubTypeName": "报销单申请事由",
      "formCode": "MK19099001",
      "formDataCode": "PC1909251U9B2K1S",
      "formName": "报销导入Junit",
      "employeeName": "张三",
      "employeeId": "190013",
      "amount": {"amount": 1200.00, "currency": "USD"},
      "departmentBizCode": "DI1803221E22UHXF",
      "departmentName": "杭州每时每刻有限公司",
      "submittedAt": 1569410436063,
      "formStatus": "APPROVING",
      "statusText": "审批中",
      "formType": "REIMBURSE",
      "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
    }]
  }
}

更新日志

Copyright © 杭州每刻科技有限公司 www.maycur.com all right reserved,powered by Gitbook该文件修订时间: 2024-11-25 12:04:35

results matching ""

    No results matching ""

    results matching ""

      No results matching ""