获取对外收款记录 - Developer OpenAPI

企业和服务商可通过此接口获取企业的对外收款记录。

补充说明:

收款记录的起止时间间隔不能超过1个月
会过滤收款人不在可见范围中的收款记录，因此返回的记录数可能会小于limit设置的最大记录数。
如果得到的列表为空，说明已经拉取完所有的数据。

权限说明：允许对外收款应用secret获取的access_token调用第三方应用调用需要企业授权对外收款的权限只会返回当前在应用可见范围内用户的收款记录。

文档ID: 24937
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/93667
https://open.work.weixin.qq.com/api/doc/90001/90143/93727

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

cursor

string

可选

用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

payee_userid

string

可选

企业收款成员userid，不填则为全部成员

end_time

integer <int32>

收款记录结束时间

必需

limit

integer <int32>

可选

返回的最大记录数，整型，最大值1000

begin_time

integer <int32>

收款记录开始时间

必需

示例

{
  "begin_time": 1605171726,
  "end_time": 1605172726,
  "payee_userid": "zhangshan",
  "cursor": "CURSOR",
  "limit": 10
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

可选

bill_list

array [object {14}]

交易单详情列表

可选

transaction_id

string

交易单号

可选

total_refund_fee

integer <int32>

退款总金额

可选

trade_state

integer <int32>

可选

交易状态。1：已完成 3：已完成有退款

remark

string

收款备注

可选

mch_id

string

收款商户号id

可选

pay_time

integer <int32>

交易时间

可选

external_userid

string

可选

付款人的userid

commodity_list

array [object {2}]

可选

商品信息详情列表,商品信息结构参考commodity

payment_type

integer <int32>

可选

收款方式。0：在聊天中收款 1：收款码收款 2：在直播间收款 3：用产品图册收款

out_trade_no

string

商户单号

可选

payee_userid

string

可选

收款人企业内账号userid

total_fee

integer <int32>

可选

收款总金额，单位为分

refund_list

array [object {6}]

可选

退款单据详情列表，退款单据详情参考refund

payer_info

object

可选

next_cursor

string

可选

分页游标，在下次请求时填写以获取之后分页的记录，如果已经没有更多的数据则返回空

errmsg

string

可选

contact_info

object

必需

联系人信息，详情参考contact，如创建收款项目时设置为不需要联系地址，则该字段为空，第三方不可获取

name

string

联系人姓名

必需

phone

string

联系人手机号

必需

address

string

联系地址

必需

示例

{
  "errcode": 0,
  "bill_list": [
    {
      "transaction_id": "string",
      "total_refund_fee": 0,
      "trade_state": 0,
      "remark": "string",
      "mch_id": "string",
      "pay_time": 0,
      "external_userid": "string",
      "commodity_list": [
        {
          "amount": 0,
          "description": "string"
        }
      ],
      "payment_type": 0,
      "out_trade_no": "string",
      "payee_userid": "string",
      "total_fee": 0,
      "refund_list": [
        {
          "refund_status": 0,
          "out_refund_no": "string",
          "refund_fee": 0,
          "refund_userid": "string",
          "refund_comment": "string",
          "refund_reqtime": 0
        }
      ],
      "payer_info": {
        "address": "string",
        "phone": "string",
        "name": "string"
      }
    }
  ],
  "next_cursor": "string",
  "errmsg": "string",
  "contact_info": {
    "name": "string",
    "phone": "string",
    "address": "string"
  }
}