付款申请接口
1. 获取付款申请单列表
请求地址
text
GET /Purchase/Payment参数说明
付款申请单查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 13,
"results": [
{
"id": "02f6d304-7571-4d87-b7da-8569eac25b13",
"serialNo": "PAY202109090001",
"companyId": 53291,
"companyCode": "AB",
"companyName": "易点易动",
"purchasePlatform": 1,
"appliedBy": 53763,
"appliedUserName": "霍龙",
"appliedTime": "1631178288",
"vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
"vendorName": "苏宁易购",
"bankName": "建设银行",
"bankAccount": "2321322154210693820",
"receiptNo": "222333444",
"comment": "付款申请",
"totalAmount": 5000.0000,
"paidAmount": 0,
"status": 1,
"details": [
{
"id": "d4109a3e-02ac-4ba7-96ce-c9f9bb5ccc43",
"payApplicationId": "02f6d304-7571-4d87-b7da-8569eac25b13",
"displayIndex": 1,
"orderSerialNo": "PAO202109030002",
"amount": 5000.0000,
"paidAmount": 0,
"orderAmount": 20040.0000,
"arrivalAmount": 0,
"notPaidAmount": 20040.0000,
"closedAmount": 0.00000000000,
"orderQuantity": 4,
"arrivalQuantity": 0,
"notArrivalQuantity": 4,
"closedQuantity": 0,
"status": 1
}
],
"attachments": []
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量，指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0 |
| results | 符合查询条件的付款申请单详情集合 |
| meta | 其他信息 |
2. 新增付款申请单
请求地址
text
POST /Purchase/Payment请求示例
json
{
"companyCode": "AB",
"appliedTime": "1631178288",
"vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
"bankName": "建设银行",
"bankAccount": "2321322154210693820",
"receiptNo": "222333444",
"comment": "付款申请",
"purchasePlatform": 1,
"details": [
{
"orderSerialNo": "PAO202109030002",
"displayIndex": 1,
"amount": 5000
}
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| companyCode | 是 | 付款公司编码 |
| appliedTime | 是 | 申请时间（时间戳格式） |
| vendorId | 是 | 供应商Id |
| bankName | 否 | 收款银行 |
| bankAccount | 否 | 银行账户 |
| receiptNo | 否 | 发票号 |
| comment | 否 | 申请说明 |
| purchasePlatform | 是 | 采购平台（暂无用，默认传1） |
| status | 否 | 该字段传1或者不传值为保存单据（草稿状态的付款申请单）、传2为保存并提交单据（已提交的付款申请单） |
| details | 是 | 付款详情 |
付款详情
| 参数 | 是否必须 | 说明 |
|---|---|---|
| orderSerialNo | 是 | 关联的采购订单号 |
| displayIndex | 是 | 显示的行号（序列号） |
| amount | 是 | 付款金额 |
返回结果
json
{
"id":"02f6d304-7571-4d87-b7da-8569eac25b13",
"serialNo":"PAY202109090001"
}结果说明
| 属性名称 | 说明 |
|---|---|
| id | 付款申请单id |
| serialNo | 付款申请单号 |
3. 修改、提交付款申请单
请求地址
text
POST Purchase/Payment/put请求示例
json
{
"serialNo": "PAY202109090001",
"companyCode": "AB",
"appliedTime": "1631178288",
"vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
"bankName": "建设银行",
"bankAccount": "2321322154210693820",
"receiptNo": "222333444",
"comment": "付款申请啊",
"purchasePlatform": 1,
"details": [
{
"orderSerialNo": "PAO202109030002",
"displayIndex": 1,
"amount": 6000
}
],
"status": 1
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| serialNo | 是 | 付款单号 |
| companyCode | 是 | 付款公司编码 |
| appliedTime | 是 | 申请时间（时间戳格式） |
| vendorId | 是 | 供应商Id |
| bankName | 否 | 收款银行 |
| bankAccount | 否 | 银行账户 |
| receiptNo | 否 | 发票号 |
| comment | 否 | 申请说明 |
| purchasePlatform | 是 | 采购平台（暂无用，默认传1） |
| status | 是 | 该字段传1为保存单据（草稿状态的付款申请单）、传2为保存并提交单据（已提交的付款申请单） |
| details | 是 | 要变更的付款详情 |
提交付款申请单时status字段传2
付款详情
| 参数 | 是否必须 | 说明 |
|---|---|---|
| orderSerialNo | 是 | 关联的采购订单号 |
| displayIndex | 是 | 显示的行号（序列号） |
| amount | 是 | 付款金额 |
返回结果
json
{
"id":"02f6d304-7571-4d87-b7da-8569eac25b13",
"serialNo":"PAY202109090001"
}结果说明
| 属性名称 | 说明 |
|---|---|
| id | 付款申请单id |
| serialNo | 付款申请单号 |
4. 删除付款申请单
请求地址
text
POST /Purchase/Payment/delete请求示例
json
{
"serialNo": "PAY202109090002"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| serialNo | 是 | 付款申请单号 |
返回结果
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. 付款申请单数据对象格式
| 属性名称 | 说明 |
|---|---|
| id | 付款申请单id |
| serialNo | 付款申请单号 |
| companyId | 付款公司id |
| companyCode | 付款公司编码 |
| companyName | 付款公司名称 |
| purchasePlatform | 采购平台（暂时无用，默认传1） |
| appliedBy | 付款人Id |
| appliedUserName | 付款人名称 |
| appliedTime | 申请付款时间（时间戳格式） |
| vendorId | 供应商id |
| vendorName | 供应商名称 |
| bankName | 收款银行 |
| bankAccount | 银行账号 |
| receiptNo | 发票号 |
| comment | 申请说明 |
| totalAmount | 付款总额 |
| paidAmount | 已支付金额 |
| status | 订单状态（1：草稿、2:已提交、3:已审批、4:已驳回、5:已完成） |
| 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:已完成） |