业务场景
该接口用于进行单据导入,在将单据导入到系统内时,会将单据自动保存到对应的员工下。
目前该接口中,仅支持部分主要字段,如果您所需要导入的字段不在文档内,请联系每刻工作人员。
注意事项:
- 若导入时,填写formCode,则会校验是否和每刻系统内单据号重复(每刻内单据作废/删除,不会释放原单据号)。
- 单机导入成功且为提交状态,将会自动执行该单据所配置的审批流程,如果需要将单据直接完成,可以直接将单据配置为空流程(即没有审批人)。
- 单据导入成功且为提交状态,会正常触发智能审核等功能,与员工手动提单相同。
- 若导入报销单stagingFlag(暂存状态)为true,则只校验单据的S级字段必填(参考文档的必填项为“是”的字段),其他必填字段由提单人手动添加并提交。
接口说明
请求类型
POST
接口地址
/api/openapi/receive/contract
请求参数说明
在各个表单中,分为系统字段、业务字段及普通字段,系统字段在表单配置界面中不会显示,如申请单中的requestUserEmpNo 字段。业务字段及普通字段,可以通过单据配置界面中的开发者模式来查看该字段导入时的的key值,其中普通字段的key值,也可以在界面中进行配置修改。
参数说明
字段名 | 类型 | 说明 | 必填性 |
---|---|---|---|
formCode | String | 合同的单据Code,有值时会使用该值作为单据号 | 否 |
formSubTypeBizCode | String | 系统字段,合同的单据类型业务编码 | 是 |
requestUserEmployeeId | String | 系统字段,合同的提单人工号(单据所属人) | 是 |
responsibleUserEmployeeIds | List<string> | 合同责任人工号列表 | 是 |
responsibleDepartmentBizCode | String | 责任部门编码 | 是 |
contractName | String | 合同名称 | 是 |
contractNum | String | 合同编码 | 遵循表单配置 |
contractAmount | AmountInput | 系统字段,合同金额 | 是 |
tradingPartnerBizCode | String | 往来单位业务编码 | 否 |
procurementDetails | List<ProcurementDetail> | 采购明细 | 否 |
paymentPlanBizCode | String | 付款计划业务编码 | 否 |
paymentPlans | List<PaymentPlan> | 付款计划 | 否 |
legalEntityBizCode | String | 公司抬头业务编码 | 否 |
payeeAccount | ContractPayeeAccount | 收款账户 | 否 |
customObject | CustomObject | 自定义普通字段 | 否 |
submittedTime | Data | 提单时间,毫秒时间戳,非必填,默认为单据导入时间 | 否 |
stagingFlag | boolean | 暂存标识,非必填,默认为false表示不暂存 | 否 |
contractCurrency | String | 合同币种 | 否(默认CNY),若填了该币种,上述其他组件金额币种会自动刷新。具体取值参考币种编码表货币代码列 |
contractDateDto | contractDateDto | 合同日期 | 遵循表单配置 |
formAssociatedList | List<FormAssociatedList> | 关联单据组件,关联单据数量需要遵循表单配置,仅限关联每刻内部单据 | 否 |
contractExpenseCodes | List<string> | 关联合同明细code,需调用合同明细导入接口接口导入 | 否 |
preConsumeCodeList | List<String> | 合同关联申请单号 | 遵循表单配置 |
FormAssociatedList 关联单据类型
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
bizCode | String() | 是 | 单据编码 |
type | String(12) | 是 | 单据类型 REIM 报销单; APPL 申请单; LOAN 借款单; CONTR 合同; |
contractDateDto 合同日期
字段名称 | 字段类型 | 字段说明 | 是否必填 |
---|---|---|---|
startDate | Long | 合同开始日期 | 是 |
endDate | Long | 合同结束日期 | 是 |
请求参数示例
{
"formCode": "FORM001",
"formSubTypeBizCode": "FORMTYPE001",
"requestUserEmployeeId": "001",
"contractName": "每刻的合同名称",
"contractNum": "合同号001",
"comment": "我是备注",
"paymentPlanBizCode": "dafault",
"tradingPartnerBizCode": "BIZ001",
"responsibleUserEmployeeIds": ["001", "002"],
"responsibleDepartmentBizCode": "DEPT001",
"legalEntityBizCode": "LEB001",
"contractAmount": {
"amount": "100",
"currency": "CNY"
},
"payeeAccount": {
"bankAcctName": "杭州每刻银行",
"bankAcctNumber": "6217000010001234123",
"paymentType": "BANK",
"accountType": "CORP"
},
"procurementDetails": [{
"commodityName": "商品名称",
"specifications": "规格",
"quantity": 1,
"unit": "单位",
"unitPrice": {
"amount": "100",
"currency": "CNY"
},
"totalAmount": {
"amount": "100",
"currency": "CNY"
}
}],
"paymentPlans": [{
"periodNo": 1,
"paymentInfo": {
"ratio": 100,
"amount": {
"amount": "50.00",
"currency": "CNY"
}
},
"expectTime": 1566204741186,
"customObject": {
"note": "付款备注"
}
}],
"customObject": {
"CF1393": "我是单行文本",
"remarkText": "我是单行文本",
"detail": [{
"CF1400": "我是单行文本",
"remarkText": "我是单行文本"
}]
},
"submittedTime":1566305356934,
"stagingFlag":true,
"contractDateDto": {
"startDate": 1566305356934,
"endDate": 1566305356938
},
"contractCcy": "USD",
"formAssociatedList": [
{
"bizCode": "mk1oo8611",
"type": "APPL"
}
],
"contractExpenseCodes": ["CE24050910I2V0YQ","CE24051010I2V0XY"],
"preConsumeCodeList": [
"mk00987"
]
}
响应参数说明
正常响应参数示例
{
"code": "ACK",
"message": "操作成功",
"data": "formCode",
"success": true
}
- 每刻校验异常响应参数示例
当每刻系统的智能审核、多维费控、预算校验异常时会返回失败
字段 | 字段类型 | 字段说明 |
---|---|---|
level | String | 异常级别 |
targetClassify | String | 触发校验类型 |
targetKey | String | 触发校验的那条数据的Code主键,校验类型为FORM时,该字段为空 |
ruleClassify | String | 校验触发的类型 |
message | String | 校验信息 |
needReason | boolean | 是否需要理由 |
level 异常等级
可取值 | 用法含义 |
---|---|
WARNING | 警告级别的信息,一般该类级别的信息不会阻止表单提交但需要提交者确认后才能继续提交(此时单据会暂存在提单人的“我的单据”内) |
ERROR | 错误级别的信息,出现此级信息会阻止表单提交(系统内不可见此单据) |
{
"code": "NACK",
"message": "系统校验失败",
"data": [
{
"level": "ERROR",
"targetClassify": "REIMBURSE_EXPENSE",
"targetKey": "CODE01",
"ruleClassify": "BUDGET_MATCH",
"message": "周重智的预算组织-打车预算科目 额度870.00 报销10000.00",
"needReason": false
}
],
"success": false
}
ruleClassify 枚举说明
枚举值 | 说明 |
---|---|
EXPENSE_REGULATE | 多维费控 |
CUSTOM_VALIDATION | |
EXPENSE_SUSPICIOUS | |
CONSUME_DURATION | 发票超期 |
INVOICE_TITLE | 发票抬头一致性校验 |
INVOICE_VALIDATION | 发票验真校验 |
EXPENSE_TYPE | 费用类型校验 |
EXPENSE_AMOUNT | 费用金额校验 |
EXPENSE_REQUIRED | |
EXTRA_SYSTEM | 外部系统校验 |
EXPENSE_INVOICE_AMOUNT | 费用金额与发票总金额是否一致 |
TRADING_PARTNER | |
REFERENCE_DATA | 构建选项公司抬头可见性校验结果 |
INVOICE_TIME | 跨年报销 |
INVOICE_NUMBER | 发票号码校验 |
FORM_KEYWORDS | 敏感词校验 |
CUSTOM_CORRELATED | 申请单已被其他报销单关联,无法多次使用 |
CONSUME_TIME | 智能审核-消费时间校验 |
CAR_ALLOWANCE | |
PAYEE_DETAIL_CONTACT_UNIT | |
CONTACT_UNIT | 往来单位校验 |
BUDGET_MATCH | 预算匹配时的异常校验 |
修改记录
2023-09-07 新增合同到期日和合同外币
2024-05-10 新增合同费用明细关联