Browse Source

添加分笔核销相关接口说明;

小铭丶 4 years ago
parent
commit
96c2de14d8
1 changed files with 174 additions and 0 deletions
  1. 174 0
      README.md

+ 174 - 0
README.md

@@ -27,6 +27,9 @@
 - [财务类接口](#%E8%B4%A2%E5%8A%A1%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [核销接口](#%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
     - [撤销核销接口](#%E6%92%A4%E9%94%80%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
+    - [创建司机费用结算单接口](#创建司机费用结算单接口)
+    - [查询司机费用结算单信息接口](#查询司机费用结算单信息接口)
+    - [分笔核销司机费用结算单接口](#分笔核销司机费用结算单接口)
 - [合同类接口](#%E5%90%88%E5%90%8C%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [创建司机合同接口](#%E5%88%9B%E5%BB%BA%E5%8F%B8%E6%9C%BA%E5%90%88%E5%90%8C%E6%8E%A5%E5%8F%A3)
     - [创建委托代收合同接口](#创建委托代收合同接口)
@@ -749,6 +752,177 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 }
 ```
 
+## 创建司机费用结算单接口
+
+**简要描述:** 创建司机费用结算单
+
+**请求 URL:** `/finance_driver_fee/save_settlement`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 180次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**customerOrderNumbers**  <br>*必填*|结算受理单列表  <br>**样例** : `[ "XXX", "XXX" ]`|< string > array|
+|**name**  <br>*必填*|司机姓名|string|
+|**phone**  <br>*必填*|司机电话|string|
+|**organizationName**  <br>*必填*|经办机构名称|string|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+## 查询司机费用结算单信息接口
+
+**简要描述:** 查询司机费用结算单信息
+
+**请求 URL:** `/finance_driver_fee/get_driver_fee_settlement`
+
+**请求方式:** GET
+
+**需要AccessToken:** 是
+
+**调用限制:** 180次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**settlementNumber**  <br>*必填*|结算单单号|< string >|
+
+- 调用成功示例
+
+```java
+{
+  "code": 200,
+  "message": null,
+  "data": {
+    "id": "5f910056095c37000a9f864e",
+    "uid": "5e23cbe0e4b0e777fc3d57dc",         #承运商uid
+    "operator": "5e23cbe0e4b0e777fc3d57dc",    #操作人
+    "operatorName": "梵梵好运",                 #操作人名称
+    "number": "CJ2010221145295153",            #结算单单号
+    "driverId": "5f0e72c40305b5000ad596aa",    #司机ID
+    "driverIdCard": "330327199407070419",      #司机身份证号
+    "driverName": "陈林",                      #司机姓名
+    "driverPhone": "18268320510",              #司机电话
+    "carId": "5f894316708947000c777c39",       #车辆ID
+    "carNumber": "浙A666666",                  #车辆牌照号
+    "plateColorCode": "1",                     #车辆颜色
+    "paidMeans": 0,
+    "payee": {
+      "id": "5f57291bc649a1000ab627cc",
+      "accountType": 0,
+      "name": "诸葛亮",                         #收款人姓名
+      "bankCode": "FJIB",                      #银行
+      "bankName": "兴业银行",                   #银行中文
+      "bankCardNumber": "9059215995469884",    #银行卡号
+      "phoneNumber": "",                       #电话
+      "idCard": "110101199003078873",          #收款人身份证号
+      "accountNo": null
+    },
+    "driverPayee": null,
+    "customerOrderNumbers": [                  #受理单单号列表
+      "S2010211416988492",
+      "S2010211420973225"
+    ],
+    "state": 1,                                #结算单状态,0: 未核销; 1: 已核销; 2: 部分核销
+    "totalFreight": 88,                        #应付金额
+    "paidFreight": 88,                         #已付金额
+    "unPaidFreight": 0,                        #未付金额
+    "totalOrders": 2,                          #订单数
+    "organizationPath": "0",                   #所属组织路径
+    "orderOrganizationPath": "0",              #订单开单机构
+    "note": null,                              #备注
+    "writeOffNumbers": [                       #核销单号列表
+      "CH2010221146820196"
+    ],
+    "writeOffResults": [                       #核销记录
+      {
+        "id": "5f91008a095c37000a9f8651",
+        "number": "CH2010221146820196",        #核销单号
+        "payType": 5,                          #支付类型,1油卡 5银行转账
+        "freight": 88,                         #核销金额
+        "totalOrders": 2                       #车次数
+      }
+    ],
+    "writeOffNumber": "CH2010221146820196",
+    "onlinePayState": 0,
+    "paidTime": null,
+    "businessMode": 0,
+    "created": 1603338326,
+    "updated": 1603338378
+  }
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+## 分笔核销司机费用结算单接口
+
+**简要描述:** 分笔核销司机费用结算单
+
+**请求 URL:** `/finance_driver_fee/write_off`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 180次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**settlementNumber**  <br>*必填*|结算单号|string|
+|**payFreight**  <br>*必填*|支付金额|string|
+|**packCount**  <br>*必填*|车次数|string|
+|**payType**  <br>*必填*|支付方式: 1油卡、5银行卡打款|string|
+|**tradeNo**  <br>*可选*|资金流水号, 油卡支付时不用传|string|
+|**note**  <br>*必填*|备注|string|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
 
 # 合同类接口