收付款单列表 - 铱云开放API 2.0

按payTime倒序

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

auditTimeEnd

number

可选

审核时间结束，时间跨度不超过1年，如果都不传时间，默认查询3个月内支付时间的单据

auditTimeStart

number

可选

审核时间开始，时间跨度不超过1年，如果都不传时间，默认查询3个月内支付时间的单据

createTimeEnd

number

可选

createTimeStart

number

可选

currentPage

integer <int32>

当前页，默认：1

可选

otherOrgIds

array[integer <int64>]

可选

交易方ID记录，最多支持50个

receiptType

string

必需

收款类型(付款:PAYMENT/收款:RECEIPT)

pageSize

integer <int64>

可选

每页大小，默认：20，最大100

payTimeEnd

number

可选

收款时间结束，时间跨度不超过1年，如果都不传时间，默认查询3个月内支付时间的单据

payTimeStart

number

可选

收款时间开始，时间跨度不超过1年，如果都不传时间，默认查询3个月内支付时间的单据

receiptCodes

array[string]

可选

收付款单编码列表，最多支持50个单号

withAssociateBill

boolean

可选

是否加载关联单据，例如订单号,默认：false

withAttachment

boolean

可选

是否加载附件，默认false

示例

{
    "auditTimeEnd": 0,
    "auditTimeStart": 0,
    "createTimeEnd": 0,
    "createTimeStart": 0,
    "currentPage": 0,
    "otherOrgIds": [
        0
    ],
    "receiptType": "string",
    "pageSize": 0,
    "payTimeEnd": 0,
    "payTimeStart": 0,
    "receiptCodes": [
        "string"
    ],
    "withAssociateBill": true,
    "withAttachment": true
}

返回响应

🟢200成功

application/json

Body

currentPage

integer <int32>

可选

items

array [object {29}]

可选

attachments

array[object (Attachment) {5}]

附件列表

可选

auditTime

string <date-time>

审核时间

可选

cancelDesc

string

作废原因

可选

cancelName

string

作废人

可选

cancelTime

string <date-time>

作废时间

可选

createName

string

制单人

必需

createTime

string <date-time>

制单时间

必需

modifyTime

string <date-time>

更新时间

必需

exemptAmount

number

可选

免除金额(优惠金额)

integer <int64>

收付款单ID

必需

money

number

收付款金额

必需

orgType

enum<string>

当前机构类型

必需

枚举值:

SUPPLIERHEADQUARTERBRANCHSTORECUSTOMERVOID

otherOrgCode

string

交易对手结构编码

可选

otherOrgId

integer <int64>

交易对手id

可选

otherOrgName

string

交易对手结构名称

可选

otherOrgType

enum<string>

交易对手结构类型

可选

枚举值:

SUPPLIERHEADQUARTERBRANCHSTORECUSTOMERVOID

payTime

string <date-time>

收付款时间

必需

paymentChannel

enum<string>

必需

收款渠道（ONLINE 1：线上，OFFLINE 2：线下）

枚举值:

ONLINEOFFLINE

paymentMethodCode

string

必需

收付款方式,1:微信，2: 支付宝，3:现金，4:银行转账

paymentMethodName

string

收付款名称

必需

realTradeAmount

number

实收/实付金额

可选

receiptAssociateBills

array[object (收付款关联业务单据) {4}]

收付款单支付明细

可选

receiptCode

string

收款单号，唯一标识

必需

remark

string

备注信息

可选

status

enum<string>

必需

状态 UN_CONFIRM:待审核 CONFIRMED:已审核 CANCEL:已作废

枚举值:

UN_CONFIRMCONFIRMEDCANCEL

subjectAccountId

integer <int64>

交易主体账户卡id

可选

subjectAccountName

string

交易主体账户名称

可选

subjectAccountNum

string

交易主体账户卡号

可选

tradeType

enum<string>

可选

交易类型（PAY, REFUND）

枚举值:

PAYREFUNDCREDIT_REFUND

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
    "currentPage": 0,
    "items": [
        {
            "attachments": [
                {
                    "fileName": "string",
                    "fileOriginalName": "string",
                    "fileSize": 0,
                    "fileType": "string",
                    "fileUrl": "string"
                }
            ],
            "auditTime": "2019-08-24T14:15:22Z",
            "cancelDesc": "string",
            "cancelName": "string",
            "cancelTime": "2019-08-24T14:15:22Z",
            "createName": "string",
            "createTime": "2019-08-24T14:15:22Z",
            "modifyTime": "2019-08-24T14:15:22Z",
            "exemptAmount": 0,
            "id": 0,
            "money": 0,
            "orgType": "SUPPLIER",
            "otherOrgCode": "string",
            "otherOrgId": 0,
            "otherOrgName": "string",
            "otherOrgType": "SUPPLIER",
            "payTime": "2019-08-24T14:15:22Z",
            "paymentChannel": "ONLINE",
            "paymentMethodCode": "string",
            "paymentMethodName": "string",
            "realTradeAmount": 0,
            "receiptAssociateBills": [
                {
                    "receiptCode": "string",
                    "shareMoney": 0,
                    "sourceBizCode": "string",
                    "sourceBizType": "ORDER"
                }
            ],
            "receiptCode": "string",
            "remark": "string",
            "status": "UN_CONFIRM",
            "subjectAccountId": 0,
            "subjectAccountName": "string",
            "subjectAccountNum": "string",
            "tradeType": "PAY"
        }
    ],
    "pageSize": 0,
    "totalCount": 0,
    "totalPage": 0
}