获取已提交的合同申请

接口: /report/contract/submitted?start={start}&end={end}&formSubType={formSubType}&status={status} GET JSON

请求参数

参数 类型 必须 默认值 主键 描述
start date Y 根据单据的修改时间,返回start(包括)之后的数据
end date Y 根据单据的修改时间, 返回end(不包括)之前的数据
submitAtStart date N 根据单据的提单时间,返回(包括)之后的数据
submitAtEnd date N 根据单据的提单时间,返回(不包括)之前的数据
approveAtStart date N 根据单据的审批通过时间,返回(包括)之后的数据
approveAtEnd date N 根据单据的审批通过时间,返回(不包括)之前的数据
formSubType string N 单据小类业务编码, 可在每刻单据类型页面设置
subsidiaryBizCode string N 业务实体业务编码, 可在每刻单据类型页面设置
status string N 流程状态, 可选值:APPROVING,COMPLETED; 分别表示: 审批中,已完成
exportStatus string N 业务状态, 可选值:DOING,ENDED,DONE; 分别表示: 进行中、已终止、已完成
processNodeName string N 单据当前所在节点名称,可在每刻单据流程图为节点设置名称
offset int Y 0 分页起始
limit int Y 500 分页条数
#
  • start, end的格式为yyyy-MM-dd
  • 如果不提供start和end, 则默认取前一个月的数据
  • start, end的区间最多支持31天
  • formSubType指单据小类的业务编码, 可以在企业设置单据与流程页面查看
  • 只返回单据的信息, 单据的详情,包括费用, 支付信息, 辅助核算等, 请通过详情接口获取
  • 接口最多返回500条记录;可通过offset, limit进行分页;
  • 结果集按照提单时间升序排列
  • 通过processNodeName查询单据存在两种特殊情况 1.单据被驳回,通过【驳回重新审核】和【驳回重新审批】来查询 2.单据被撤回,通过【撤回重新审批】和【撤回重新审核】来查询

返回数据

参数 类型 描述
contract_id string 合同编号
contract_name string 合同名称
amount number 合同总金额
existAttachments boolean 是否存在附件
paid_amount number 已履行金额
paying_amount number 支付中金额
applicant_employee_no string 申请人工号
applicant_user_name string 申请人名称
agent_employee_no string 责任人工号
agent_user_name string 责任人名称
supplier_code string 供应商业务编码
supplierName string 供应商业务名称
department_code string 申请部门编码
departmentName string 申请部门名称
subsidiary_code string 业务实体编码
subsidiaryName string 业务实体名称
bill_type string 单据类型编码
formSubTypeName string 单据类型名称
status string 流程状态, 可选值:APPROVING,COMPLETED; 分别表示: 审批中,已完成
biz_status string 业务状态, 可选值:DOING,ENDED,DONE; 分别表示: 进行中、已终止、已完成
attachments.fileName string 附件文件名
attachments.fileUrl string 附件下载地址
customFormValues List<CustomFormValue> 自定义字段
businessCode string 合同单据唯一编码
baseCcy string 币种
approval_process.user_code string 审批人编号
approval_process.user_name string 审批人名字
approval_process.approval_time long 审批时间
approval_process.taskName string 审批节点名称
approval_process.approvalComment string 审批意见
approval_process.taskCategory string 审批节点类型, APPROVAL, FINANCE_AUDIT,CASHIER_SETTLE
finance_codes string 审核人编号
finance_codes string 审核人编号
currency string 合同币种
comments string 合同备注
CustomFormValue 结构(详细说明请参考-自定义字段参数说明
参数 类型 描述
name string 自定义字段名称
identifier string 自定义字段占位符
type string 自定义字段类型
value string 自定义字段内容
optionBizCode string 选项编码
detailFieldValues List<Map<String,String>> 明细表格内容
detailFieldMapping Map<String,CustomFormValue> 明细表格结构,key:identifier, value:type+name
installmentFieldValues List<Map<String,String>> 分期付款类型字段

detailFieldValues 里面多了一个结构

参数 类型 描述
optionInfo Map 明细字段包含选项的信息
{
    "detailFieldValues": [
                             {
                                 "field21":"选项2,选项3",
                                 "field22":"选项1,选项2",
                                 "optionInfo":{
                                     "field21":{
                                         "value":"选项2,选项3",
                                         "optionBizCode":"xuanxiang2,xuanxiang3"
                                     },
                                     "field22":{
                                         "value":"选项1,选项2",
                                         "optionBizCode":"xuanxiang1,xuanxiang2"
                                     }
                                 }
                             }
                         ]
}
参数 类型 描述
installmentFieldValues List<Map<String,String>> 分期付款类型字段
fieldXX-1 付款金额
fieldXX-2 支付状态(PAID-已支付)(UNPAID-未支付)(PAYING-支付中)
fieldXX-3 付款日期
componentDataCode 更新付款计划对应期数编码(不传表示新增)
{
 "installmentFieldValues":[
                        {
                            "field5-1":100,
                            "field5-3":"PAID",
                            "field5-2":"2021-03-29",
                            "componentDataCode":"CDC2207061NTN0V40",
                            "formDataCode":"PR2207111VJDH8U8"
                        },
                        {
                            "field5-1":700,
                            "field5-2":"2021-03-30",
                            "field5-3":"UNPAID",
                            "componentDataCode":"CDC2207061NTN17R4",
                            "formDataCode":null
                        }
                    ]
}

示例:

请求数据

/report/contract/submitted?start=2018-06-18&end=2018-06-31&offset=0&limit=2

返回数据(成功)

{
    "code": "ACK",
    "message": "",
    "data": [
        {
            "unpaidAmount": 1.00,
            "applicantUserCode": "UI2109011D03Y4U8",
            "supplierName": "供应商-公司",
            "supplierType": "CORP",
            "departmentName": "研发组2",
            "subsidiaryName": "测试环境Team4",
            "formSubTypeName": "采购合同",
            "existAttachments": false,
            "businessCode": "MK8220208863",
            "baseCcy": "CNY",
            "currency": "TWD",
            "comments": "备注",
            "customFormValues": [
                {
                    "identifier": "field11",
                    "name": "采购合同og字段1",
                    "type": "SingleTextInput",
                    "value": "1",
                    "detailFieldValues": null,
                    "detailFieldMapping": null,
                    "installmentFieldValues": null,
                    "optionBizCode": null
                },
                {
                    "identifier": "field12",
                    "name": "采购合同字段2",
                    "type": "SingleTextInput",
                    "value": "1",
                    "detailFieldValues": null,
                    "detailFieldMapping": null,
                    "installmentFieldValues": null,
                    "optionBizCode": null
                },
                {
                    "identifier":"field5",
                    "name":"分期付款",
                    "type":"Installment",
                    "value":null,
                    "detailFieldValues":null,
                    "detailFieldMapping":null,
                    "installmentFieldValues":[
                        {
                            "field5-1":100,
                            "field5-3":"PAID",
                            "field5-2":"2021-03-29",
                            "componentDataCode":"CDC2207061NTN0V40",
                            "formDataCode":"PR2207111VJDH8U8"
                        },
                        {
                            "field5-1":700,
                            "field5-2":"2021-03-30",
                            "field5-3":"UNPAID",
                            "componentDataCode":"CDC2207061NTN17R4",
                            "formDataCode":null
                        }
                    ],
                    "optionBizCode":null
                }
            ],
            "contract_id": "321412412",
            "contract_name": "1",
            "paid_amount": 0,
            "paying_amount": 0,
            "amount": 1.00,
            "applicant_employee_no": "210365",
            "applicant_user_name": "李科君",
            "agent_employee_no": "210365",
            "agent_user_name": "李科君",
            "supplier_code": "010401",
            "subsidiary_code": "SI2108271GITDG5G",
            "bill_type": "FT2108271KNUMI9S",
            "submitted_at": 1648625146539,
            "updated_at": 1648625146539,
            "status": "APPROVING"
        }
    ],
    "args": null,
    "linkDetail": false,
    "last": true,
    "total": 1,
    "nonBizError": false
}

返回数据(失败)

{
  "code": "ACK",
  "message": "请检查输入参数",
  "data": null,
  "args": null,
  "linkDetail": false,
  "last": true,
  "nonBizError": false
}

results matching ""

    No results matching ""