付款登记接口
1. 获取付款登记单列表
请求地址
text
GET /Purchase/Payment/Registration参数说明
付款登记单查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 2,
"results": [
{
"applicationId": "5c48b88e-d77f-4f85-824e-001a617f7bfc",
"isPaid": true,
"paymentTime": "1604902742",
"payComment": "哦",
"id": "7a202e21-38be-4d79-9f39-8169947be815",
"serialNo": "PAY202011090002",
"companyId": 7023,
"companyCode": "01",
"companyName": "测试",
"purchasePlatform": 1,
"appliedBy": 6261,
"appliedUserName": "尚德",
"appliedTime": "1604902728",
"vendorId": "6f360896-85e6-472b-a15d-aabd4eaa3d78",
"vendorName": "供应",
"bankName": "3212321221224423331",
"bankAccount": "admin",
"receiptNo": "2322122223",
"comment": "啊",
"totalAmount": 9.0000,
"paidAmount": 9.0000,
"status": 0,
"details": [
{
"id": "7a7c5052-fd4a-4999-9e87-54956dd94b33",
"payApplicationId": "5c48b88e-d77f-4f85-824e-001a617f7bfc",
"displayIndex": 1,
"orderSerialNo": "PAO202011090002",
"amount": 9.0000,
"paidAmount": 9.0000,
"orderAmount": 9.0000,
"arrivalAmount": 0,
"notPaidAmount": 0.0000,
"closedAmount": 0.00000000000,
"orderQuantity": 3,
"arrivalQuantity": 0,
"notArrivalQuantity": 3,
"closedQuantity": 0,
"status": 3
}
],
"attachments": []
}
]
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量，指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0 |
| results | 符合查询条件的付款登记单详情集合 |
| meta | 其他信息 |
2. 新增付款登记单
请求地址
text
POST /Purchase/Payment/Registration请求示例
json
{
"paymentTime": "1630653350",
"payComment": "备注",
"purchasePlatform": 1,
"payApplicationSerialNos": [
"PAY202109030001"
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| paymentTime | 是 | 付款日期（时间戳） |
| payComment | 否 | 付款说明 |
| purchasePlatform | 否 | 采购平台（暂无用，默认传1） |
| payApplicationSerialNos | 是 | 付款申请单的单据号集合 |
返回结果
json
{"
ids":{
"8a91e254-766b-465f-801c-8e4cfe721e72":"PAY202109030001"
}
}结果说明
| 属性名称 | 说明 |
|---|---|
| ids | 登记单id与单据号 |
3. 删除付款登记单
请求地址
text
POST /Purchase/Payment/Registration/DELETE请求示例
json
{
"id":"8a91e254-766b-465f-801c-8e4cfe721e72"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 付款登记单id |
返回结果
json
{}对于成功删除的请求，该接口仅返回HTTP 200 OK
附录
1. 支持的查询参数
如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。
分页
skip={数字} 跳过指定条数的记录数
take={数字} 取出指定条数的记录数（注：最大值为1500，即单页最多返回1500条数据）
include=total 需要返回记录总数
排序
orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age
条件过滤
不等于
{属性名称}!={值} 如：Id!=1
大于等于
>{属性名称}={值} 如：>Id=1
大于
{属性名称}>={值} 如：Id>=1
小于
<{属性名称}={值} 如：<Id=1
小于等于
{属性名称}<={值} 如：Id<=1
In
{属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3
Between
{属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3
字符串包含指定字符
{属性名称}Contains={值} 如：nameContains=abc
字符串以指定字符开头
{属性名称}StartsWith={值} 如：nameStartsWith=abc
字符串以指定字符结尾
{属性名称}EndsWith={值} 如：nameEndsWith=abc
2. 数据实体格式
1. 付款登记单数据对象格式
| 属性名称 | 说明 |
|---|---|
| applicationId | 付款申请单id |
| isPaid | 是否付款 |
| paymentTime | 付款时间（时间戳格式） |
| payComment | 付款说明 |
| id | 付款登记单id |
| serialNo | 付款登记单号 |
| companyId | 付款公司id |
| companyCode | 付款公司编码 |
| companyName | 付款公司名称 |
| purchasePlatform | 采购平台（暂无用；0:天猫、1京东） |
| appliedBy | 申请人id |
| appliedUserName | 申请人用户名 |
| appliedTime | 申请时间（时间戳格式） |
| vendorId | 供应商id |
| vendorName | 供应商名称 |
| bankName | 付款开户银行 |
| bankAccount | 付款开户银行帐号 |
| receiptNo | 发票号 |
| totalAmount | 付款总额 |
| paidAmount | 已支付金额 |
| status | 无作用 |
| details | 付款登记单包含的采购订单详情集合 |
| attachments | 附件信息（请从pc端操作附件） |
付款登记单包含的采购订单详情
| 属性名称 | 说明 |
|---|---|
| id | 采购订单id |
| payApplicationId | 付款申请单id |
| displayIndex | 显示的行号（序列号） |
| orderSerialNo | 采购订单号 |
| amount | 付款金额 |
| paidAmount | 已支付金额 |
| orderAmount | 订单金额 |
| arrivalAmount | 到货金额 |
| notPaidAmount | 未支付金额 |
| closedAmount | 关闭金额 |
| orderQuantity | 订单数量 |
| arrivalQuantity | 到货数量 |
| notArrivalQuantity | 未到货数量 |
| closedQuantity | 关闭数量 |
| status | 订单状态（1:草稿、2:已提交、3:已审批、4:已驳回、5:已关闭、6:已完成） |