合同列表接口

业务场景说明

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

注意事项

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

接口地址

/api/openapi/form/v2/contract

请求类型

POST

请求参数

参数说明

请求参数示例

{
  "createdAtStart": 1569859200000,
  "createdAtEnd": 1569945600000,
  "submittedAtStart": 1569859200000,
  "submittedAtEnd": 1569945600000,
  "approvedAtStart": 1569859200000,
  "approvedAtEnd": 1569945600000,
  "formSubTypeBizCode": "FST0001",
  "formStatus": "COMPLETED",
  "procInstEndTimeStart": 1569859200000,
  "procInstEndTimeEnd": 1569945600000,
  "exportStatus": 0,
  "legalEntityBizCodes": [
    "ELC21102113BP29A8"
  ],
  "formCodes": [
    "FORMCODE001"
  ],
  "externalStates": [
    "A",
    "EMPTY"
  ],
  "fillUserList": [
    "MK001"
  ],
  "agentEmployeeIds": [
    "MK001"
  ],
  "pageNo": 1,
  "pageSize": 10
}

响应参数说明

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

响应数据示例

{

  "code": "ACK", 
  "message": "成功",  
  "data":{
    "hasNextPage": true,
    "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
    }]
  }
}

修改记录

2023-09-12  新增合同列表接口文档