保证金台账查询接口

说明

查询保证金/押金台账列表。接口为只读查询,数据来源为保证金台账,不处理退还、转费用、坏账等状态写入。

接口限制

  • 分页大小最大为 100。
  • reimburseCodesexpenseTypeBizCodesnoReceiptSubTypeBizCodestradingPartnerBizCodeslegalEntityBizCodesexternalVoucherNos 单次最多 50 个。
  • responsibleEmployeeIds 单次最多 20 个。
  • 保证金台账仅包含预付款分类为 DEPOSITGUARANTEE 的数据。
  • OpenAPI 不支持模糊关键字搜索;外部凭证号更新使用单据号 + 保证金编号精确定位。
  • 账龄范围查询通过 numberSearches 传入,field 固定为 ageDays
  • 查询结果只返回对外业务编码,不返回台账内码、费用内码、formDataCode、表单定义编码等内部字段。

接口地址

/api/openapi/account-book/deposit/search

请求类型

POST

请求参数

参数说明

参数名称 类型 是否必填 参数说明
statuses List<String> 台账状态:PAID 已支付、PARTIALLY_SETTLED 部分结清、SETTLED 已结清、BAD_DEBT 已坏账、ABANDON 已废弃
reimburseCodes List<String> 单据号列表
expenseTypeBizCodes List<String> 费用类型业务编码列表
noReceiptSubTypeBizCodes List<String> 预付款类型选项业务编码列表
noReceiptTypes List<String> 预付款分类:DEPOSIT 保证金、GUARANTEE 押金
tradingPartnerBizCodes List<String> 往来单位业务编码列表
legalEntityBizCodes List<String> 公司抬头/法人实体业务编码列表
externalVoucherNos List<String> 外部凭证号列表
receiptStatuses List<String> 收据状态:RECEIVED 已收到、NOT_RECEIVED 未收到
receiptMedium String 收据介质:PAPER 纸质、ELECTRONIC 电子
responsibleEmployeeIds List<String> 责任人工号列表,最多 20 个
paymentDateStart Long 支付日期开始时间
paymentDateEnd Long 支付日期结束时间
forecastReceiptDateStart Long 预计回收日期开始时间
forecastReceiptDateEnd Long 预计回收日期结束时间
itemSearches List<DepositBookCustomSearch> 档案/选项类共享字段筛选
singleTextSearches List<DepositBookCustomSearch> 单行文本共享字段筛选
multiTextSearches List<DepositBookCustomSearch> 多行文本共享字段筛选
numberSearches List<DepositBookCustomSearch> 数字共享字段筛选;账龄范围查询也使用该字段
amountSearches List<DepositBookCustomSearch> 金额共享字段筛选
dateTimeSearches List<DepositBookCustomSearch> 日期时间共享字段筛选
staffSearches List<DepositBookCustomSearch> 人员共享字段筛选
serialNumberSearches List<DepositBookCustomSearch> 流水号共享字段筛选
sortField String 排序字段,支持 paymentDateforecastReceiptDateconsumeAmountnonReceiptAmountageDays
sortDirection String 排序方向:ASCDESC,默认按下游台账规则倒序
pageNo Integer 页码,默认为 1
pageSize Integer 分页大小,默认为 50,最大为 100

DepositBookCustomSearch

参数名称 类型 是否必填 参数说明
field String 共享字段 identifier;账龄筛选固定传 ageDays
searchCodeList List<String> 档案/选项类字段编码列表,仅 itemSearches 使用
searchText String 文本搜索值,singleTextSearchesmultiTextSearchesstaffSearchesserialNumberSearches 使用
min BigDecimal 数字/金额最小值,numberSearchesamountSearches 使用
max BigDecimal 数字/金额最大值,numberSearchesamountSearches 使用
startTime Long 日期时间开始时间戳,仅 dateTimeSearches 使用
endTime Long 日期时间结束时间戳,仅 dateTimeSearches 使用

参数样例

{
  "statuses": ["PAID", "PARTIALLY_SETTLED"],
  "reimburseCodes": ["MK26040032"],
  "expenseTypeBizCodes": ["bzj001"],
  "noReceiptSubTypeBizCodes": ["BID_DEPOSIT"],
  "noReceiptTypes": ["DEPOSIT", "GUARANTEE"],
  "tradingPartnerBizCodes": ["TP-BIZ-001"],
  "legalEntityBizCodes": ["LE-BIZ-001"],
  "receiptStatuses": ["NOT_RECEIVED"],
  "responsibleEmployeeIds": ["E0001"],
  "paymentDateStart": 1780243200000,
  "paymentDateEnd": 1782835199999,
  "forecastReceiptDateStart": 1796054400000,
  "forecastReceiptDateEnd": 1798732799999,
  "externalVoucherNos": ["EXT26050001"],
  "itemSearches": [
    {
      "field": "CF1001",
      "searchCodeList": ["OPT001", "OPT002"]
    }
  ],
  "numberSearches": [
    {
      "field": "ageDays",
      "min": 30,
      "max": 90
    }
  ],
  "sortField": "forecastReceiptDate",
  "sortDirection": "ASC",
  "pageNo": 1,
  "pageSize": 50
}

响应参数

响应参数说明

字段名称 字段类型 字段说明
hasNextPage Boolean 是否有下一页
list List<OpenApiDepositBook> 保证金台账列表

OpenApiDepositBook

字段名称 字段类型 字段说明
depositNo String 保证金编号
reimburseCode String 关联单据号
contractCodes List<String> 关联合同单号列表
expenseTypeBizCode String 费用类型业务编码
noReceiptSubTypeBizCode String 预付款类型选项业务编码
noReceiptType String 预付款分类:DEPOSIT 保证金、GUARANTEE 押金
tradingPartnerBizCode String 往来单位业务编码
legalEntityBizCode String 公司抬头/法人实体业务编码
consumeAmount MonetaryAmount 保证金金额
doneReturnAmount MonetaryAmount 已退还金额
processReturnAmount MonetaryAmount 退还中金额
doneAmount MonetaryAmount 已转费用金额
processAmount MonetaryAmount 转费用中金额
nonReceiptAmount MonetaryAmount 剩余金额。坏账时不递减,保留坏账确认前的剩余金额
consumeCcy String 消费币种
paymentDate Long 支付日期
forecastReceiptDate Long 预计回收日期
receiptMedium String 收据介质:PAPER 纸质、ELECTRONIC 电子
receiptStatus String 收据状态:RECEIVED 已收到、NOT_RECEIVED 未收到
status String 台账状态:PAID 已支付、PARTIALLY_SETTLED 部分结清、SETTLED 已结清、BAD_DEBT 已坏账、ABANDON 已废弃
badDebtReason String 坏账原因,仅坏账状态有值
badDebtAmount MonetaryAmount 坏账核销金额,等于坏账确认时剩余金额快照
externalVoucherNo String 外部凭证号
customObject Object 费用表单共享字段,按 OpenAPI 字段格式返回
receiptAttachments List<AttachData> 保证金/押金收据附件
createdAt Long 创建时间
createdByEmployeeId String 创建人工号
ageDays Integer 账龄天数,仅未结清且超过预计回收日期时返回大于 0 的值

MonetaryAmount

参数名称 类型 描述
amount BigDecimal 金额
currency String 币种

AttachData

参数名称 类型 描述
name String 附件名称
url String 附件访问地址
pdfUrl String PDF 预览/下载地址,无转换结果时为空

参数样例

{
  "code": "ACK",
  "message": null,
  "data": {
    "list": [
      {
        "depositNo": "MK26040032-A1",
        "reimburseCode": "MK26040032",
        "contractCodes": ["HT26050001"],
        "expenseTypeBizCode": "bzj001",
        "noReceiptSubTypeBizCode": "BID_DEPOSIT",
        "noReceiptType": "DEPOSIT",
        "tradingPartnerBizCode": "TP-BIZ-001",
        "legalEntityBizCode": "LE-BIZ-001",
        "consumeAmount": {
          "amount": 5000.00,
          "currency": "CNY"
        },
        "doneReturnAmount": {
          "amount": 0.00,
          "currency": "CNY"
        },
        "processReturnAmount": {
          "amount": 1000.00,
          "currency": "CNY"
        },
        "doneAmount": {
          "amount": 0.00,
          "currency": "CNY"
        },
        "processAmount": {
          "amount": 0.00,
          "currency": "CNY"
        },
        "nonReceiptAmount": {
          "amount": 5000.00,
          "currency": "CNY"
        },
        "consumeCcy": "CNY",
        "paymentDate": 1780329600000,
        "forecastReceiptDate": 1796140800000,
        "receiptMedium": "ELECTRONIC",
        "receiptStatus": "RECEIVED",
        "status": "PAID",
        "badDebtReason": null,
        "badDebtAmount": null,
        "externalVoucherNo": "EXT26050001",
        "customObject": {
          "CF1001": {
            "detailBusinessCode": "OPT001",
            "businessCode": "REF-BIZ-001",
            "text": "项目A"
          }
        },
        "receiptAttachments": [
          {
            "name": "保证金收据.pdf",
            "url": "https://example.com/deposit-receipt.pdf",
            "pdfUrl": null
          }
        ],
        "createdAt": 1780329600000,
        "createdByEmployeeId": "E0001",
        "ageDays": 0
      }
    ],
    "hasNextPage": false
  },
  "requestId": null,
  "errorCode": null,
  "success": true
}

修改记录

2026-06-30  按最新 OpenAPI 返回口径调整:不返回内部 code;查询入参使用业务编码并移除内码入参;contractCodes 改为数组;收据附件按台账维度返回;补充返回枚举中文描述
2026-06-17  同步开发分支逻辑:移除模糊关键字、成本中心、凭证号,新增公司抬头、共享字段、账龄范围筛选和 customObject 返回
2026-05-29  新增保证金台账查询接口文档
Copyright © 杭州每刻科技有限公司 www.maycur.com all right reserved,powered by Gitbook该文件修订时间: 2026-07-09 09:57:03

results matching ""

    No results matching ""

    results matching ""

      No results matching ""