API开放平台

TIP

# 新增修改收款单（收预存款）接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/savePreDeposit/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"supply_id": "-1",
    "supply_code": "",
	"cm_code": "",
    "modify":"1",
    "receive_no":"SK20230706000001",
	"business_type": "",
	"capitalpool_code": "",
	"from_details": [
		{
			"settlement_name": "",
			"amount": ""
		}
	],
	"receive_date": "",
	"receiver": "",
	"remark": "",
	"main_exts": [
		{
			"ext_name": "",
			"ext_value": ""
		},
		{
			"ext_name": "",
			"ext_value": ""
		}
	]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
supply_id VARCHAR(32) 否  收款单位id。收款单位id和收款单位编码必须传一个。厂家/直接经销商传值为-1
supply_code VARCHAR(100) 否 收款单位编码，收款单位id和收款单位编码必须传一个 
cm_code VARCHAR(100) 是  客户编码 
modify VARCHAR(32) 否  只有修改时需要传，且传的值为1 
receive_no VARCHAR(32) 否  收款单号。有该单号且modify为1时则修改该收款单。 
business_type VARCHAR(100) 是  收款类型。0：收欠款，1：收订金，2：退订金 3：收预存款，不支持修改
capitalpool_code VARCHAR(100) 是  资金池编码
receive_date TIMESTAMP 是  收款日期。格式：yyyy-MM-dd
receiver VARCHAR(100) 是  收款人 （编码）
remark VARCHAR(300) 否 备注说明
from_details List 列表
from_details.settlement_name VARCHAR(100) 是  收款方式名称 
from_details.amount VARCHAR(100) 是  收款金额
main_exts List 自定义字段列表
main_exts.ext_name VARCHAR(100) 否  自定义字段名称
main_exts.ext_value VARCHAR(100) 否  自定义字段值 

响应示例：

{
	"msg_id": "X000001",
	"return_code": 1,
	"return_msg": "",
	"response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据。JSON字符串；receive_id：收款单id；receive_no：收款单号。                                                   

# 新增修改收款单（收货款）接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/saveGoodsDeposit/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"supply_id": "-1",
	"supply_code": "",
	"cm_code": "",
	"modify": "1",
	"receive_no": "SK20230706000001",
	"business_type": "",
	"pool_details": [
		{
			"capitalpool_code": "",
			"use_amount": ""
		}
	],
	"from_details": [
		{
			"settlement_name": "",
			"amount": ""
		}
	],
	"receive_discount_amount": "",
	"receive_date": "",
	"receiver": "",
	"remark": "",
	"main_exts": [
		{
			"ext_name": "",
			"ext_value": ""
		},
		{
			"ext_name": "",
			"ext_value": ""
		}
	],
	"details": [
		{
			"bill_code": "TH20211109000005",
			"amount": "200",
			"bill_type": ""
		}
	]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
supply_id VARCHAR(32) 否 收款单位id。收款单位id和收款单位编码必须传一个。厂家/直接经销商传值为-1
supply_code VARCHAR(100) 否 收款单位编码，收款单位id和收款单位编码必须传一个
cm_code VARCHAR(100) 是  客户编码 
modify VARCHAR(32) 否  只有修改时需要传，且传的值为1 
receive_no VARCHAR(32) 否  收款单号。不传则自动生成。有该单号且modify为1时则修改该收款单。 
business_type VARCHAR(100) 是 收款类型。0：收欠款，1：收订金，2：退订金 3：收预存款，不支持修改
pool_details List  列表
pool_details.capitalpool_code VARCHAR(100) 否  使用预存款子表-资金池编码
pool_details.use_amount VARCHAR(100) 否  使用预存款子表-使用金额
receive_date TIMESTAMP 是  收款日期。格式：yyyy-MM-dd
receiver VARCHAR(100) 是  收款人（编码） 
remark VARCHAR(300) 是 备注说明
receive_discount_amount VARCHAR(100) 是 收款优惠
from_details List 列表
from_details List 列表
from_details.settlement_name VARCHAR(100) 是  收款子表-收款方式名称 
from_details.amount VARCHAR(100) 是 收款子表-收款金额
details List 列表
details.bill_code VARCHAR(100) 是 关联单据-单据号
details.amount VARCHAR(100) 是 关联单据-本单结算金额
details.bill_type VARCHAR(100) 是 关联单据-单据类型。CXD：车销单，ZYFHD：直营发货单，FXFHD：分销发货单，CPD：车铺单，THD：退货单
main_exts List 列表
main_exts.ext_name VARCHAR(100) 否  自定义字段名称
main_exts.ext_value VARCHAR(100) 否  自定义字段值 

响应示例：

{
	"msg_id": "X000001",
	"return_code": 1,
	"return_msg": "",
	"response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据 。JSON字符串；receive_id：收款单id；receive_no：收款单号。

# 收款单查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/getReceivableInfos/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "page_number": 1,
    "page_length": 100,
    "supply_id": -1,
    "cm_code": "USER001",
    "start_create_date": "2016-12-09",
    "end_create_date": "2016-12-19",
    "start_modify_date": "2017-12-09",
    "end_modify_date": "2017-12-09"
}

参数说明：

参数 类型 必填 说明
supply_id VARCHAR(32) 否 收款单位ID。总部传-1。
cm_code VARCHAR(100) 否 客户编码
start_create_date TIMESTAMP 否 创建时间开始。格式：yyyy-MM-dd
end_create_date TIMESTAMP 否 创建时间结束。格式：yyyy-MM-dd
start_modify_date TIMESTAMP 否 修改时间开始。格式：yyyy-MM-dd
end_modify_date TIMESTAMP 否 修改时间结束。格式：yyyy-MM-dd
page_number INT 否 页码默认值为1，每页默认1000条
page_length INT 否 每页记录条数，默认最大是1000条，可以根据数据的大小自行优化调整
order_no VARCHAR(32) 否 订单单号

响应示例：

{
	"return_code": true,
	"response_data":"<<DATA>>"
}

数据DATA示例:

[
		{
			"id": "",
			"receive_no": "",
			"confirm_status": "",
			"confirm_status_name": "",
			"cm_id": "",
			"cm_code": "",
			"cm_name": "",
			"supply_id": "",
			"supply_code": "",
			"supply_name": "",
			"receive_type": "",
			"receive_type_name": "",
			"capitalpool_id": "",
			"capitalpool_code": "",
			"capitalpool_name": "",
			"small_amount": "",
			"receive_date": "",
			"emp_name": "",
			"remark": "",
             "details": [
				{
					"bill_id": "",
					"bill_code": "",
					"bill_type": "",
					"bill_type_name": "",
					"bill_amount": ""
				}
			],
			"pool_detail": [
				{
					"pool_detail_id": "",
					"pool_detail_code": "",
					"pool_detail_amount": ""
				}
			],
			"settlement_detail": [
				{
					"settlement_detail_id": "",
					"settlement_detail_name": "",
					"settlement_detail_amount": ""
				}
			],
			"ext_infos": [
				{
					"ext_code": "",
					"ext_name": "",
					"ext_value": ""
				}
			]
		}
]

参数说明：

参数 类型 必填 说明
id INT8 否 收款单ID
receive_no VARCHAR(32) 否 收款单号
confirm_status VARCHAR(32) 否 状态。0：待审批，1：待入账，2：已作废，3：已入账
confirm_status_name VARCHAR(100) 否 状态名称
cm_id VARCHAR(100) 否 客户id
cm_code VARCHAR(100) 否 客户编码
cm_name VARCHAR(100) 否 客户名称
supply_id INT8 否 收款单位id
supply_code VARCHAR(100) 否 收款单位编码
supply_name VARCHAR(100) 否 收款单位名称
receive_type VARCHAR(32) 否 业务类型。0：收货款，2：退订金 3：收预存款
receive_type_name VARCHAR(100) 否 收款类型名称
capitalpool_id INT8 否 资金池id
capitalpool_code VARCHAR(100) 否 资金池编码
capitalpool_name VARCHAR(100) 否 资金池名称
small_amount VARCHAR(100) 否 收款优惠
receive_date VARCHAR(100) 否 收款日期
emp_name VARCHAR(100) 否 收款人
remark text 否 备注说明
details.bill_id INT8 否 关联单据-单据id
details.bill_code VARCHAR(100) 否 关联单据-单据号
details.bill_type VARCHAR(100) 否 关联单据-单据类型。CXD：车销单，FHD：发货单，CPD：车铺单，THD：退货单
details.bill_type_name VARCHAR(100) 否 关联单据-单据类型名称
details.bill_amount VARCHAR(100) 否 关联单据-本单结算金额
pool_detail List 使用预存款子表列表
pool_detail.pool_detail_id INT8 否 使用预存款子表-资金池id
pool_detail.pool_detail_code VARCHAR(100) 是 使用预存款子表-资金池编码
pool_detail.pool_detail_amount VARCHAR(100) 否 使用预存款子表-使用金额
settlement_detail List 否 收款子表列表
settlement_detail.settlement_detail_id INT8 否 收款子表-收款方式id
settlement_detail.settlement_detail_name VARCHAR(100) 否 收款子表-收款方式名称
settlement_detail.settlement_detail_amount VARCHAR(100) 否 收款子表-收款金额
ext_infos VARCHAR(100) 否 自定义字段列表
ext_infos.ext_code VARCHAR(100) 否 自定义字段-编码
ext_infos.ext_name VARCHAR(100) 否 自定义字段-名称
ext_infos.ext_value VARCHAR(100) 否 自定义字段-值

# 收款单审批接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/approvalReceivableHistory/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"receive_id": "-1",
	"receive_no": "",
	"confirm_emp_id": "",
	"confirm_emp_code": "",
	"operate_type": "",
	"confirm_reason": ""
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
receive_id VARCHAR(32) 否 收款单id
receive_no VARCHAR(100) 否 收款单编码，收款单id和收款单编码必须传一个
confirm_emp_id VARCHAR(32) 否  操作人id 
confirm_emp_code VARCHAR(100) 否 操作人编码，操作人id和操作人编码必须传一个
operate_type VARCHAR(32) 是  操作类型，1：确认；2：取消
confirm_reason TEXT 否  审批说明

响应示例：

{
	"msg_id": "X000001",
	"return_code": 1,
	"return_msg": "",
	"response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据

# 客户信用额度更新接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/updateCredQuota/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "cmCode": "CUS000111",
    "supplyCode":"999999",
    "credAmount":"12.05",
    "credDay":"14"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cmCode VARCHAR(32) 是 客户编码
supplyCode VARCHAR(32) 否 收款单位编码，默认为999999，代表企业
credAmount VARCHAR(100) 是 信用额度,最多存储两位小数
credDay VARCHAR(100) 否 信用天数，必须为整数

响应示例：

{
	"msg_id": "X000001",
	"return_code": 1,
	"return_msg": "",
	"response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据

# 收款单反入账接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/callBackReceivableHistory/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "receive_no": "SK20230516000006",
    "callback_emp_code": "hx",
    "callback_reason": "反入账"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
receive_id VARCHAR(32) 是 收款单ID，收款单号和收款单ID必须传一个
receive_no VARCHAR(32) 否 收款单号，收款单号和收款单ID必须传一个
callback_emp_id VARCHAR(32) 否  操作人id 
callback_emp_code VARCHAR(100) 否 操作人编码，操作人id和操作人编码必须传一个
callback_reason VARCHAR(32) 否 反入账原因

响应示例：

{
	"msg_id": "X000001",
	"return_code": 1,
	"return_msg": "",
	"response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据

# 客户信用额度查询

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/receivableHistory/v1/queryCredQuota/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "page_number": 1,
    "page_length": 100,
    "supply_code": "999999",
    "cm_code": "USER001",
    "start_create_date": "2016-12-09",
    "end_create_date": "2016-12-19",
    "start_modify_date": "2017-12-09",
    "end_modify_date": "2017-12-09",
    "status": "1",
    "sales_org_code": ""
}

参数说明：

参数 类型 必填 说明
supply_code VARCHAR(32) 否 收款单位编码。999999代表企业
cm_code VARCHAR(32) 否 客户编码
start_create_date TIMESTAMP 否 创建时间开始。格式：yyyy-MM-dd
end_create_date TIMESTAMP 否 创建时间结束。格式：yyyy-MM-dd
start_modify_date TIMESTAMP 否 修改时间开始。格式：yyyy-MM-dd
end_modify_date TIMESTAMP 否 修改时间结束。格式：yyyy-MM-dd
status VARCHAR(32) 否 删除状态。0：已删除，1：正常
sales_org_code VARCHAR(32) 否 销售组织编码
page_number INT 否 页码默认值为1，每页默认1000条
page_length INT 否 每页记录条数，默认最大是1000条，可以根据数据的大小自行优化调整

响应示例：

{
	"return_code": true,
	"response_data":"<<DATA>>"
}

数据DATA示例:

[
		{
			"cm_code": "",
			"credibility_amount": "",
			"credibility_day": "",
			"create_time": "",
			"modify_time": "",
			"supply_code": "",
			"sales_org_code": "",
			"status": ""
		}
]

参数说明：

参数 类型 必填 说明
cm_code VARCHAR(32) 否 客户编码
credibility_amount VARCHAR(32) 否 信用额度
credibility_day VARCHAR(32) 否 信用天数
create_time VARCHAR(32) 否 创建时间
modify_time VARCHAR(32) 否 修改时间
supply_code VARCHAR(32) 否 收款单位编码，默认为999999，代表企业
sales_org_code VARCHAR(32) 否 销售组织编码
status VARCHAR(32) 否 删除状态。0：已删除，1：正常

# 客户信用额度推送

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
  "cm_code": "",
  "credibility_amount": "",
  "credibility_day": "",
  "create_time": "",
  "modify_time": "",
  "supply_code": "",
  "sales_org_code": "",
  "status": ""
}

参数说明：

参数 类型 必填 说明
cm_code VARCHAR(32) 否 客户编码
credibility_amount VARCHAR(32) 否 信用额度
credibility_day VARCHAR(32) 否 信用天数
create_time VARCHAR(32) 否 创建时间
modify_time VARCHAR(32) 否 修改时间
supply_code VARCHAR(32) 否 收款单位编码，默认为999999，代表企业
sales_org_code VARCHAR(32) 否 销售组织编码
status VARCHAR(32) 否 删除状态。0：已删除，1：正常

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

参数说明：

参数 说明
return_code 响应编码
return_msg 响应消息内容
msg_id 消息ID

← 收款单推送 →