[关闭]
@lina 2020-08-23T12:35:21.000000Z 字数 12791 阅读 287

新版货达人快递 1.1 后台接口文档

列表项
新版货达人 1.1 后台

1、项目约定

1.1 基本约定

1.1.1 API Base Url

1.1.2 鉴权字段(身份标识)

  • X-auth-token : [string] 登录后获取的 token 信息, 取window.token 请求头带此字段
  • X-org-code : [string]https://www.zybuluo.com/mdeditor# 机构表识字段,所有请求均需要此字段，取window.orgCode 请求头带此字段
  • X-location : [string] 坐标 lng-lat 请求头带此字段
  • X-unique-key : [string] 服务端下发的标识，取window.uniqueKey 请求头带此字段
  • X-city : [string] 所在城市名称 请求头带此字段
  • X-platform-code : [string] 平台标识字段,所有请求均需要此字段，取window.platformCode 请求头带此字段

1.1.3 HTTP请求中字段要求

  • POST请求Content-Type为：Content-Type:application/x-www-form-urlencoded
  • 文件上传时Content-Type为：Content-Type:multipart/form-data
  • 对于：Content-Type:application/json：Content-Type:application/xml不保证完全支持，请谨慎使用

1.2 通用接口

1.2.1 通用接口URL

1.2.2 上传图片

通用图片上传文件服务

请求URL

POST
/image

请求参数

  • file : 文件

响应

  1. {
  2.     error_code: 0,
  3.     data: {
  4.         url: 'http://xxx'
  5.     }
  6. }
  • url : [string] 文件的访问URL

1.2.3 验证码图片

注：请求图片时，需解析图片的cookie，不然无法认证

GET
/captcha

1.2.4 发送短信

POST
/verifycode

请求参数

  • captcha_code : [string] 图形验证码
  • phone : [string] 手机号

响应

  1. {
  2.     error_code: 0,
  3.     data: {
  4.     }
  5. }

1.3 通用响应字段

1.3.1 状态字段

  • error_code: [int] 服务器状态码，0 为正常状态，异常状态待定。
  • error_message：[string] 错误信息，但 error_code 不为 0 时返回

1.3.2 数据字段

  • data: [object] 数据字段，所有响应数据都在此字段中
  • list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

  • page: [int] 当前页码，默认为1
  • total: [int] 总页数
  • pageSize: [int]
    每页数量：本项目常用page_size==10

示例

  1. {
  2.     status: 0,
  3.     msg: '',
  4.     data: {
  5.         list: [{
  6.             key: value
  7.         }],
  8.         total: 23
  9.     }
  10. }

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

sex:[int]

0: 未知
1: 男
2: 女

2.1.2 审核状态

verify_status:[int]

0: 审核中
1: 通过
2: 驳回

2.1.3 是否启用状态

status: [int]

0:未启用
1:启用

2.1.3 订单状态

status: [int]

0:待抢单
1:已抢单
2:已拒绝
3:已完成
4:订单未完成

2.2 核心结构

2.2.1 用户基本信息 （v2.0修改）

  1. {
  2.     id: 123,
  3.     nick_name: '梦里花落知多少',
  4.     real_name: 'xx',
  5.     phone: '15500000000',
  6.     sex: 1,
  7.     avatars: 'http://image.com/1.jpeg',
  8.     id_number: 110101198803031321,
  9.     bank_number: '7112312321',
  10.     id_card_front: 'url',
  11.     id_card_back: 'url',
  12.     sign_photo: 'url',
  13.     company_id: 12,
  14.     region_id: 12,
  15.     bus_quarter_id: 23,
  16.     department_id: 12,
  17.     bus_depart_id: 12,
  18.     last_month_income: 0,
  19.     total_income: 0,
  20.     intro_courier_id: 12,
  21.     intro: @用户基本信息
  22.     user_remarks:'银行卡所属分行是 支行是'
  23. }
  • id: [int] 用户ID
  • nick_name: [string] 用户名
  • phone: [string] 用户手机
  • avatars: [string] 头像
  • real_name: [string] 姓名
  • sex: [integer] 性别
  • id_number: [string] 身份证号
  • bank_number: [string] 银行卡号
  • bank_name: [string] 银行名称
  • id_card_front: [string] 身份证正面照片url
  • id_card_back: [string] 身份证反面照片url
  • sign_photo: [string] 签字照片
  • company_id: [int] 快递公司id
  • region_id: [int] 大区id
  • bus_quarter_id: [int] 营业区id
  • department_id: [int] 分部id，可能为空
  • bus_depart_id: [int] 营业部id
  • last_month_income: [int] 上月收入
  • total_income: [int] 总收入
  • intro_courier_id: [int] 被推荐人的courier_id
  • intro: [object] 被推荐人的基本用户信息，可能为空
  • user_remarks: [string] 用户备注

2.2.2 订单信息

  1. {
  2.     id: 12,
  3.     courier_id: 1232,
  4.     remark: '中关村南大街',
  5.     start_time: '7112312321',
  6.     end_time: 7777.23,
  7.     status: 0,
  8.     company:{
  9.         @快递公司
  10.     },
  11.     region: {
  12.         @大区
  13.     },
  14.     bus_quarter: {
  15.         @营业区
  16.     },
  17.     department: {
  18.         @分部
  19.     },
  20.     bus_depart: {
  21.         @营业部
  22.     }
  23. }
  • id: [int] 订单ID
  • courier_id: [string] 快递员用户id
  • remark: [string] 线路备注
  • start_time: [date] 开始时间
  • end_time: [date] 结束时间
  • status: [integer] 订单状态
  • company: [obj] 快递公司信息
  • region: [obj] 大区信息
  • bus_quarter: [obj] 营业区信息
  • department: [obj] 分部信息（可能为null）
  • bus_depart: [obj] 营业部信息

2.2.3 公司、大区、营业区等

公司

  1. {
  2.     id: 12,
  3.     company_name: 1232,
  4.     contact_name: '中关村南大街',
  5.     contact_phone: '7112312321',
  6.     status: 0,
  7.     province_id: 0,
  8.     province_name: 0,
  9.     city_id: 0,
  10.     city_name: 0,
  11.     county_id: 0,
  12.     county_name: 0,
  13.     bus_quarter_num: 12,
  14.     region_num: 123,
  15.     addr: 0,
  16. }
  • id: [int] 公司ID
  • company_name: [string] 公司名称
  • contact_name: [string] 联系人姓名
  • contact_phone: [string] 联系人电话
  • status: [int] 启用弃用状态
  • province_id: [string] 省份id
  • province_name: [string] 省份名称
  • city_id: [string] 城市id
  • city_name: [string] 城市名称
  • county_id: [string] 区县id
  • county_name: [string] 区县名称
  • addr: [string] 具体地址
  • bus_quarter_num: [int] 营业区数量
  • region_num: [int] 大区数量

其他的看数据库吧，就不一一写出来，字段基本都一样的

2.2.4 分部和营业部

分部相对于公司等，多个一个后台管理用户对象

  1. {
  2.     id: 12,
  3.     department_name: 1232,
  4.     contact_name: '中关村南大街',
  5.     contact_phone: '7112312321',
  6.     status: 0,
  7.     province_id: 0,
  8.     province_name: 0,
  9.     city_id: 0,
  10.     city_name: 0,
  11.     county_id: 0,
  12.     county_name: 0,
  13.     addr: 0,
  14.     user: {
  15.         username: 'xxx'
  16.     }
  17. }
  • id: [int] 分部ID
  • department_name: [string] 分部名称
  • contact_name: [string] 联系人姓名
  • contact_phone: [string] 联系人电话
  • status: [int] 启用弃用状态
  • province_id: [string] 省份id
  • province_name: [string] 省份名称
  • city_id: [string] 城市id
  • city_name: [string] 城市名称
  • county_id: [string] 区县id
  • county_name: [string] 区县名称
  • addr: [string] 具体地址
  • user: [obj] 后台管理对象

营业部就不列出来，字段基本都一样的

2.2.5 路径信息

  1. {
  2.     id: 12,
  3.     company_id: 1232,
  4.     region_id: 12,
  5.     bus_quarter_id: 12,
  6.     department_id: 0,
  7.     bus_depart_id: 12,
  8.     route: "路径1",
  9.     status: 1,
  10. }
  • id: [int] 分部ID
  • route: [string] 路径名称（长度最大256）
  • status: [int] 0 禁用 1 启用

2.2.6 财务信息（v3.0新增）

  1. {
  2.     liability_compensation:有责赔偿
  3.     platform_award: 平台奖励,
  4. }
  • liability_compensation: [string] 有责赔偿
  • platform_award: [string] 平台奖励

2.2.7 后台用户注册信息（v3.0新增）

  1. {
  2.     company:公司名称
  3.     contact_name: 联系人
  4.     contact_phone: 联系人电话
  5.     business: 主营业务
  6.     courier_num: 合作伙伴人数
  7. }

3、接口列表

3.1 合作伙伴类接口

3.1.1 合作伙伴编辑

请求URL

PUT
/courier/${courier_id}

请求参数

  • 除了之前的字段，还添加了下面两个字段
  • leader_id: [string] 角色为队员时必填，为队长的courier_id
  • role_type: [int] 0队长，1队员【必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": null
  5. }

3.1.2 合作伙伴信息接口

请求URL

GET
/courier/${courier_id}

请求参数

无

响应
队员只会有leader对象，队长会有teammates

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": {
  5.         @用户基本信息
  6.         teammates: [
  7.         {
  8.             id: 1,
  9.             real_name: 'xxx',
  10.             leader_id: 12,
  11.         }
  12.         ],
  13.         leader: {
  14.             id: 1,
  15.             real_name: 'xxx',
  16.             leader_id: 12,
  17.         }
  18.     }
  19. }

3.1.3 获取队员列表（只有队长才有权限）

请求URL

GET
/courier/${courier_id}/teammates

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": {
  5.         list: [
  6.             @用户基本信息
  7.         ],
  8.         total: 122 // 总数
  9.     }
  10. }

3.1.4 根据手机号获取队长

请求URL

GET
/courier/get_leader

请求参数

  • phone: [string] 手机号必须是11位手机号 【必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": [
  5.         {
  6.             "id": 1, // courier表对应的id
  7.             "real_name": "姚明",
  8.         }
  9.     ]
  10. }

3.2 红包管理

3.2.1 红包获取记录列表

请求URL

GET
/envelope

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • status: [string] 红包状态筛选【非必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": {
  5.         list: [
  6.             {
  7.                 courier_id: 12
  8.                 income_id: 12
  9.                 courier: {},
  10.                 income: {},
  11.                 elp_date: '',//日期
  12.                 amount: 012,// 金额
  13.                 open_time: '',//红包打开领取时间
  14.                 status: '',//红包领取状态 0 - 待领取 1 - 已领取  2 - 未领取
  15.                 expire_time: '', //失效
  16.             }
  17.         ],
  18.         total: 122 // 总数
  19.     }
  20. }

3.2.2 红包提现列表

请求URL

GET
/envelope/withdraw

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • asExcel: [int] 1为导出【非必填】
  • company_id/bus_depart_id等大区id查询

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": {
  5.         'withdraw' : 122, // 已提现金额
  6.         'elp_num' => 122, // 红包个数
  7.         'total_amount' => 1222,// 总金额,
  8.         'unwithdraw' => 33,// 未提现金额
  9.         list: [
  10.             {
  11.                 courier_id: 12
  12.                 income_id: 12
  13.                 courier: {},
  14.                 start_date: '2019-09-01',
  15.                 end_date: '2019-09-15',
  16.                 bus_require: '业务需求方',
  17.                 item_name: '费用项目',
  18.                 amount: 1222,// 总金额
  19.                 withdraw_amt: 111,// 提现金额
  20.                 fee: 12, 
  21.                 draw_time: ''//提现时间,
  22.                 sign_photo: ''
  23.             }
  24.         ],
  25.         total: 122 // 总数
  26.     }
  27. }

3.3 财务

3.3.1 财务提现列表

请求URL

GET
/income/withdraw

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • asExcel: [int] 1为导出【非必填】
  • company_id/bus_depart_id等大区id查询

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": {
  5.         list: [
  6.             {
  7.                 courier_id: 12
  8.                 courier: {},
  9.                 start_date: '2019-09-01',
  10.                 end_date: '2019-09-15',
  11.                 bus_require: '业务需求方',
  12.                 item_name: '费用项目',
  13.                 amount: 1222,// 总金额
  14.                 withdraw_amt: 111,// 提现金额
  15.                 fee: 12, 
  16.                 draw_time: ''//提现时间,
  17.                  sign_photo: ''
  18.             }
  19.         ],
  20.         total: 122 // 总数
  21.     }
  22. }

3.3.2 导出提现凭证PDF

请求URL

GET
/withdraw/export

请求参数

  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • type: [int] 1为财务提现凭证PDF导出，2为红包提现凭证PDF【非必填】默认为1

响应

  1. 导出的文件

3.4 邀请提现

3.4.2 是否可以邀请提现

请求URL

get
/courier/can_notice

请求参数

无

响应

  1. {
  2.     "status": 0,
  3.     "msg": "操作成功",
  4.     "data": true // true单日可以点击提现，false单日不可以点击
  5. }

3.4.2 邀请提现（原邀请提现接口作废）

请求URL

post
/courier/notice

请求参数

无

响应

  1. {
  2.     "status": 0,
  3.     "msg": "操作成功",
  4.     "data": null
  5. }

4、通达人接口

4.1 新版财务接口（12月23号调整）

4.1.1 财务首页

请求URL

GET
/t_income

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • phone: [string] 手机号，右模糊 【非必填】
  • customer_id: [string] 用户编号，右模糊 【非必填】
  • real_name: [string] 姓名，右模糊 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • asExcel: [int] 1为导出【非必填】
  • company_id/bus_depart_id等大区id查询

响应

  1. {
  2.     "data": {
  3.         'list' => [{
  4.             courier: {} // 用户编号存在情况下不为空
  5.             其他信息见数据库t_income,
  6.             income_date: '2019-01-01', // 财务日期
  7.         }],
  8.         'total' => 100
  9.     }
  10. }

4.1.2 提现单列表

请求URL

GET
/user_income

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • phone: [string] 手机号，右模糊 【非必填】
  • customer_id: [string] 用户编号，右模糊 【非必填】
  • real_name: [string] 姓名，右模糊 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • asExcel: [int] 1为导出【非必填】
  • company_id/bus_depart_id等大区id查询

响应

  1. {
  2.     "status": 0,
  3.     "msg": "保存成功",
  4.     "data": {
  5.         list: [
  6.             {
  7.                 courier_id: 12
  8.                 courier: {},
  9.                 start_date: '2019-09-01',
  10.                 end_date: '2019-09-15',
  11.                 withdraw_amt: 111,// 提现金额
  12.                 draw_time: ''//提现时间,
  13.                  sign_photo: ''
  14.             }
  15.         ],
  16.         total: 122 // 总数
  17.     }
  18. }

4.1.3 导出提现凭证PDF

请求URL

GET
/user_income/export

请求参数

  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】

响应

  1. 导出的文件

4.2 收入统计

4.2.1 收入统计列表

请求URL

GET
/t_income_sts

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • phone: [string] 手机号，右模糊 【非必填】
  • customer_id: [string] 用户编号，右模糊 【非必填】
  • real_name: [string] 姓名，右模糊 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • asExcel: [int] 1为导出【非必填】
  • company_id/bus_depart_id等大区id查询

响应

  1. {
  2.     "data": {
  3.         'list' => [{
  4.             courier: {} // 用户编号存在情况下不为空
  5.             income_cnt: '订单数量',
  6.             income_amt: '订单总金额',
  7.             income_date: '财务日期',
  8.             liability_compensation: '有责赔偿',
  9.             platform_award decimal: '平台奖励',
  10.             remark: '备注',
  11.             其他信息见数据库t_income_daily_sts
  12.         }],
  13.         'total' => 100
  14.     }
  15. }

4.2.1 收入统计导入（原来/income/import弃用，逻辑还是一样的只是amount不需要传了）

请求URL

put
/t_income_sts/import

只更新有责赔偿和平台奖励以及金额

4.3 五级区域

4.3.1 五级区域新建和编辑

请求URL

POST/PUT 新建和编辑url以及方法不变

请求参数

  • @原先的不变，新增如下
  • st_amount [string] 设置预提现金额

响应

  1. {
  2.     "status": 0,
  3.     "msg": "新建成功",
  4.     "data": null
  5. }

5、新版货达云接口（2020-08-09）

5.1 提现配置接口

5.1.1 新增修改提现配置接口

请求URL

POST
/company/{id}/withdrawal/config

请求参数

  • id: [integer] 公司id 【必填】
  • config: [object] 财务配置，详见下文描述 【必填】

按固定日期提现数据格式

  1. {
  2.     "type": 1,//提现类型，1为固定日期提现
  3.     "config": [//提现配置
  4.         {
  5.             "begin": 1,//开始日期
  6.             "end": 10,//结束日期
  7.             "percent_wages": 70,//提现比例
  8.             "withdrawal_config": [//开发申请提现日期配置
  9.                 {
  10.                     "begin": {//开始配置配置
  11.                         "month_type": 1,//月份类型 1当月 2次月
  12.                         "day": 11//日期， 1~27， 月底用32表示
  13.                     },
  14.                     "end": {//结束日期配置
  15.                         "month_type": 1,
  16.                         "day": 15//日期， 1~27， 月底用32表示
  17.                     },
  18.                     "fee": 3//利率
  19.                 },
  20.                 ...
  21.             ]
  22.         },
  23.         {
  24.             "begin": 11,
  25.             "end": 20,
  26.             "percent_wages": 70,
  27.             "withdrawal_config": [
  28.                 ...//提现配置
  29.             ]
  30.         }
  31.     ]
  32. }

按工资日期时间提现数据格式

  1. {
  2.     "type": 2,//提现类型，2为按工资日期提现
  3.     "after_day": 5,//几天后可提现
  4.     "percent_wages": 5,//提现比例
  5.     "withdrawal_config": [//提现配置
  6.         {//当月15日及以前，费率3%
  7.             "month_type": 1,//月份类型 1当月 2次月
  8.             "day": 15,//日期 1~27  月底为32
  9.             "fee": 3//费用
  10.         },
  11.         {//次月3日及以前，费率1%
  12.             "month_type": 2,//月份类型 1当月 2次月
  13.             "day": 3,
  14.             "fee": 1
  15.         }
  16.     ]
  17. }

响应

  1. {
  2.     "status": 0,
  3.     "msg": "",
  4.     "data": {
  5.         "type": 1,
  6.         "config": [
  7.             {
  8.                 "begin": 1,
  9.                 "end": 10,
  10.                 "percent_wages": 70,
  11.                 "withdrawal_config": [
  12.                     {
  13.                         "begin": {
  14.                             "month_type": 1,
  15.                             "day": 11
  16.                         },
  17.                         "end": {
  18.                             "month_type": 1,
  19.                             "day": 15
  20.                         },
  21.                         "fee": 3
  22.                     },
  23.                     {
  24.                         "begin": {
  25.                             "month_type": 2,
  26.                             "day": 1
  27.                         },
  28.                         "end": {
  29.                             "month_type": 2,
  30.                             "day": 5
  31.                         },
  32.                         "fee": 1
  33.                     },
  34.                     {
  35.                         "begin": {
  36.                             "month_type": 2,
  37.                             "day": 16
  38.                         },
  39.                         "end": {
  40.                             "month_type": 2,
  41.                             "day": 32
  42.                         },
  43.                         "fee": 2
  44.                     }
  45.                 ]
  46.             },
  47.             {
  48.                 "begin": 11,
  49.                 "end": 20,
  50.                 "percent_wages": 70,
  51.                 "withdrawal_config": [
  52.                     {
  53.                         "begin": {
  54.                             "month_type": 1,
  55.                             "day": 1
  56.                         },
  57.                         "end": {
  58.                             "month_type": 1,
  59.                             "day": 10
  60.                         },
  61.                         "fee": 3
  62.                     },
  63.                     {
  64.                         "begin": {
  65.                             "month_type": 1,
  66.                             "day": 11
  67.                         },
  68.                         "end": {
  69.                             "month_type": 1,
  70.                             "day": 21
  71.                         },
  72.                         "fee": 2
  73.                     },
  74.                     {
  75.                         "begin": {
  76.                             "month_type": 1,
  77.                             "day": 22
  78.                         },
  79.                         "end": {
  80.                             "month_type": 2,
  81.                             "day": 5
  82.                         },
  83.                         "fee": 1
  84.                     }
  85.                 ]
  86.             },
  87.             {
  88.                 "begin": 21,
  89.                 "end": 32,
  90.                 "percent_wages": 70,
  91.                 "withdrawal_config": [
  92.                     {
  93.                         "begin": {
  94.                             "month_type": 2,
  95.                             "day": 1
  96.                         },
  97.                         "end": {
  98.                             "month_type": 2,
  99.                             "day": 10
  100.                         },
  101.                         "fee": 2
  102.                     },
  103.                     {
  104.                         "begin": {
  105.                             "month_type": 2,
  106.                             "day": 11
  107.                         },
  108.                         "end": {
  109.                             "month_type": 2,
  110.                             "day": 32
  111.                         },
  112.                         "fee": 1
  113.                     }
  114.                 ]
  115.             }
  116.         ]
  117.     }
  118. }

5.1.2 获取提现配置接口

请求URL

GET
/company/{id}/withdrawal/config

请求参数

  • id: [integer] 公司id 【必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "",
  4.     "data": {
  5.         "type": 2,
  6.         "after_day": 5,
  7.         "percent_wages": 5,
  8.         "withdrawal_config": [
  9.             {
  10.                 "month_type": 1,
  11.                 "day": 15,
  12.                 "fee": 3
  13.             },
  14.             {
  15.                 "month_type": 1,
  16.                 "day": 25,
  17.                 "fee": 2
  18.             },
  19.             {
  20.                 "month_type": 2,
  21.                 "day": 3,
  22.                 "fee": 1
  23.             },
  24.             {
  25.                 "month_type": 2,
  26.                 "day": 5,
  27.                 "fee": 0.5
  28.             }
  29.         ]
  30.     }
  31. }

5.1.3 获取当月提现配置接口

请求URL

GET
/company/{id}/withdrawal

请求参数

  • id: [integer] 公司id 【必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "",
  4.     "data": {
  5.         "change": false,//是否与下月配置不一致
  6.         "config": {
  7.             "type": 2,
  8.             "after_day": 5,
  9.             "percent_wages": 5,
  10.             "withdrawal_config": [
  11.                 {
  12.                     "month_type": 1,
  13.                     "day": 15,
  14.                     "fee": 3
  15.                 },
  16.                 {
  17.                     "month_type": 1,
  18.                     "day": 25,
  19.                     "fee": 2
  20.                 }
  21.             ]
  22.         }
  23.     }
  24. }

5.1.4 预支记录

请求URL

GET
/user/withdraw

请求参数

  • page: [string] 当前页数 【必填】
  • pageSize: [string] 每页数量【非必填】
  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】
  • asExcel: [int] 1为导出【非必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "",
  4.     "data": {
  5.         "list": [
  6.             {
  7.                 "id": 40,
  8.                 "courier_id": 65,
  9.                 "month_start": "2020-07",
  10.                 "month_end": "",
  11.                 "amount": "2000.00", //预支金额
  12.                 "withdraw_amt": "1940.00", //实际到账金额
  13.                 "fee": "3.00", //手续费
  14.                 "draw_time": "2020-08-10 23:35:03",//申请时间
  15.                 "sign_photo": "https://api.ane.huodaren.net/uploads/2020-06/223681591376047.png",
  16.                 "order_sn": "11111",// 订单号
  17.                 "status": 1,//状态 1提现中 2提现成功 3提现失败
  18.                 "last_reply_state": "",
  19.                 "withdrawal_config": null,
  20.                 "created_at": "-0001-11-30 00:00:00",
  21.                 "updated_at": "2020-08-11 23:42:21",
  22.                 "month": "2020-07", //涉及月份
  23.                 "courier": {
  25.                 }
  26.             },
  27.             {
  28.                 "id": 41,
  29.                 "courier_id": 84,
  30.                 "month_start": "2020-06",
  31.                 "month_end": "2020-07",
  32.                 "amount": "4000.00",
  33.                 "withdraw_amt": "3880.00",
  34.                 "fee": "3.00",
  35.                 "draw_time": "2020-08-10 23:43:49",
  36.                 "sign_photo": "https://api.ane.huodaren.net/uploads/2020-06/223681591376047.png",
  37.                 "order_sn": "",
  38.                 "status": 2,
  39.                 "last_reply_state": "",
  40.                 "withdrawal_config": null,
  41.                 "created_at": "-0001-11-30 00:00:00",
  42.                 "updated_at": "2020-08-12 23:04:31",
  43.                 "month": "2020-06,2020-07",
  44.                 "courier": {
  45.                 }
  46.             }
  47.         ],
  48.         "total": 2 //总数
  49.     }
  50. }

5.1.5 导出预支凭证PDF

请求URL

GET
/user/withdraw/export

请求参数

  • keyword: [string] 关键字 【非必填】
  • start_date: [string] 筛选开始日期【非必填】
  • end_date: [string] 筛选结束日期【非必填】

响应

  1. 导出的文件

5.1.6 预支明细

请求URL

GET
/user/withdraw/{id}/detail

请求参数

  • id: [string] 预支id 【必填】

响应

  1. {
  2.     "status": 0,
  3.     "msg": "",
  4.     "data": [
  5.         {
  6.             "id": 41,
  7.             "courier_id": 84,
  8.             "income_id": 98,
  9.             "user_withdrawal_id": 41,
  10.             "amount": "0.00", //收入
  11.             "platform_award": "2000.00", //平台奖励
  12.             "liability_compensation": "0.00",//惩罚
  13.             "fee_rate": "1.00",//费率
  14.             "percent_wages": "70",//体现比例
  15.             "created_at": "-0001-11-30 00:00:00",
  16.             "updated_at": "-0001-11-30 00:00:00",
  17.             "courier": {
  18.                 //用户信息
  19.             },
  20.             "income": {
  21.             //关联的收入记录
  22.             }
  23.         },
  24.         {
  25.             "id": 42,
  26.             "courier_id": 84,
  27.             "income_id": 135,
  28.             "user_withdrawal_id": 41,
  29.             "amount": "0.00",
  30.             "platform_award": "2000.00",
  31.             "liability_compensation": "0.00",
  32.             "fee_rate": "3.00",
  33.             "percent_wages": "70",
  34.             "created_at": "-0001-11-30 00:00:00",
  35.             "updated_at": "-0001-11-30 00:00:00",
  36.             "courier": {
  37.             },
  38.             "income": {
  39.             }
  40.         }
  41.     ]
  42. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注