获取附件

  • 接口:/attachment/list

  • Method:POST

  • 数据格式:JSON

注:本接口单次请求最大查询关联业务编码为50条,接口采用异步查询的方式,第一次查询会创建对应的查询任务,查询方需要轮询本接口,当查询任务完成之后会返回对应的状态在对应的【业务关键编码(attachmentRefBizCode)】的对象中,状态为(COMPLETED)表示结果可用,其余状态需要再次查询本接口,特别提示:每次任务的有效时间为1小时,也就是说当任务创建并且执行完成之后,单据修改或新增附件,接口返回结果不会实时变更,更新附件信息的更新会有一个小时的延迟;

  • 请求参数:
字段 类型 必填 默认值 描述
attachmentRefBizCodes List Y 附件关联编码,(例如,普通报销单的的附件,此处应为 报销单的业务编码集合)特别提示:当查询发票(INVOICE)的附件的时候,这里的值为每刻的发票编码(invoiceDataCode)
attachmentRefType String Y 附件关联的类型 ,可选值:INVOICE(发票)、REIMBURSE(对私报销)、PRECONSUME(申请单)、REPAYMENT(对私收款)、CORP_REIMBURSE(对公报销)、CORP_REPAYMENT(对公收款)、CORP_CONTRACT(采购合同)
ifReturnExpenseAttachment boolean N false 是否返回费用的附件(目前只有"attachmentRefType"为"REIMBURSE(对私报销)"和"CORP_REIMBURSE(对公报销)"类型时,这个字段生效)
  • 返回数据:
字段 类型 描述
attachmentRefBizCode String 附件关联编码
attachmentRefType String 附件关联的类型
status String 查询执行状态(SUBMITTED/已提交,PROCESSING/进行中, COMPLETED/已完成, ERROR/执行失败)
errMsg String 错误提示信息(当status为 "ERROR" 的时候,会有相应的提示信息)
attachmentDtos List 附件信息

AttachmentDto:字段解析

字段 类型 描述
fileName String 附件名称
downloadUrl String 下载链接
mimeType String 文件类型(PDF/IMG)
qrCodePic boolean 是否为发票主图片
size long 文件大小(单位:比特)
hash String 文件hash
md5 String 文件md5
feeCode String 费用编码
feeTypeCode String 费用类型编码
feeTypeName String 费用类型名称

请求示例:

{
    "timestamp": "1545902846044",
    "data":{
        "attachmentRefBizCodes":["biz_1","biz_2"],
        "attachmentRefType":"INVOICE",
        "ifReturnExpenseAttachment":true
    }
}
  • 返回示例:
{
  "code":"ACK",
  "message":"",
  "data":[
        {
        "attachmentRefBizCode":"biz_1", //附件关联编码
        "attachmentRefType":"INVOICE", //附件关联的类型
        "status":"COMPLETED",//查询状态
        "errMsg":null, //错误提示信息(当status为Error 的时候,会有相应的提示信息)
        "attachmentDtos":[
            {
              "mimeType":"application/pdf",//附件类型
              "fileName":"a_01",//附件名称
              "downloadUrl":"https://invoice-test.maycur.com/c8726430-d15d-4d2a-9e1e-40eed4abbd79.pdf?e=1606958865&token=cQAoIFQK1rR3_2NgfDcJu5zzTgZjGBUD-Ghot7mv:hBHlsUqvqZk8fzeWXHYFwmRjv_k=",//附件下载地址
              "size":39013, //文件大小
              "qrCodePic": true //是否是发票主图片
              "hash":"Fv5kAN3o7qak5PAc_VkLB-B3r2Qq", // 文件hash
              "md5":"dcb3a687a0a1b12e7623e86a312679fd" // 文件md5,
              "feeCode": "",
              "feeTypeCode":"",
              "feeTypeName": ""
              }
          ]//附件信息
        },
        {
        "attachmentRefBizCode":"biz_2", //附件关联编码
        "attachmentRefType":"INVOICE", //附件关联的类型
        "status":"ERROR",//查询状态
        "errMsg":"单据不存在,请检查请求参数", //错误提示信息(当status为Error 的时候,会有相应的提示信息)
        "attachmentDtos":[]
        }
  ],
  "args":null,
  "linkDetail":false,
  "last":true,
  "nonBizError":false
}

特别:当传入的单据没有附件时,返回参数示例,单据没有附件是正常的业务场景,不需根据参数去下载附件,不是获取失败;

{
  "code":"ACK",
  "message":"",
  "data":[
        {
        "attachmentRefBizCode":"biz_1", //附件关联编码
        "attachmentRefType":"INVOICE", //附件关联的类型
        "status":"COMPLETED",//查询状态
        "errMsg":null, //错误提示信息(当status为Error 的时候,会有相应的提示信息)
        "attachmentDtos":[]//单据附件为空(单据没有附件,单据费用关联的发票没有附件)
        },
        {
        "attachmentRefBizCode":"biz_2", //附件关联编码
        "attachmentRefType":"INVOICE", //附件关联的类型
        "status":"ERROR",//查询状态
        "errMsg":"单据附件信息未找到,请联系管理员处理 ", //错误提示信息(当status为Error 的时候,会有相应的提示信息)
        "attachmentDtos":[]
        }
  ],
  "args":null,
  "linkDetail":false,
  "last":true,
  "nonBizError":false
}
  • 系统异常说明表
异常提示信息 描述
* 单据不存在,请检查请求参数 传入单据编码不存在(attachmentRefBizCode)
* 单据附件信息未找到,请联系管理员处理 获取单据附件下载信异常时抛出,需要提供单据号联系每刻管理员排查
* 系统未知异常,请联系管理员处理 获取时发现系统未知异常,需要提供单据号联系每刻排查

results matching ""

    No results matching ""