财务中台--百胜

简介:财务中台文档

HOST:localhost:8180

联系人:王萌、林哲

Version:1.0.0

接口路径:/v2/api-docs?group=1.0.0

[TOC]

百胜Open接口

收款

接口地址:/openApi/bs/collectPayment

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "dataList": [
    {
      "cashierCode": "",
      "cashierName": "",
      "currency": "",
      "dataList": [
        {
          "currency": "",
          "giftCardNo": "",
          "offStoreOrderNo": "",
          "recChannelCode": "",
          "recChannelName": "",
          "recFaceAmount": 0,
          "recRealAmount": 0
        }
      ],
      "offStoreCode": "",
      "offStoreOrderNo": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderType": 0,
      "recTime": "",
      "recType": "",
      "totalPreFaceAmount": 0,
      "totalPreRealAmount": 0,
      "totalRecFaceAmount": 0,
      "totalRecRealAmount": 0
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	资金收款AO	资金收款AO
dataList	收款数据行		true	array	Payment
cashierCode	收银员编码		true	string
cashierName	收银员名称		true	string
currency	币种		true	string
dataList	收款明细行		true	array	PaymentDetail
currency	币种		true	string
giftCardNo	礼品卡号		false	string
offStoreOrderNo	门店订单号		true	string
recChannelCode	收款渠道编码		true	string
recChannelName	收款渠道名称		false	string
recFaceAmount	收款面值金额		true	number
recRealAmount	收款本金金额		true	number
offStoreCode	门店编码		true	string
offStoreOrderNo	门店订单号		true	string
orderCreateTime	单据创建时间 格式:yyyy-MM-dd HH:mm:ss		true	string
orderCreator	单据创建人		true	string
orderType	订单类型，0:门店订单，1:预售订单，2:定金订单，3:店定网络订单		true	integer
recTime	收款时间 格式:yyyy-MM-dd HH:mm:ss		true	string
recType	收款类型，receive:收款 back:退款		true	string
totalPreFaceAmount	预收订单面值总金额		false	number
totalPreRealAmount	预收订单本金总金额		false	number
totalRecFaceAmount	收款总面值金额		true	number
totalRecRealAmount	收款总本金金额		true	number
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
message		string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

配货入库接口

接口地址:/openApi/bs/dispatchStorageOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "dataList": [
    {
      "dataList": [
        {
          "omsStockSn": "",
          "qty": 0,
          "skuCode": ""
        }
      ],
      "dispatchOrderType": 0,
      "invSerialNo": "",
      "invTime": "",
      "offStoreCode": "",
      "offStoreName": "",
      "omsInvSerialNo": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "tradeNo": ""
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	配货入库列表VO	配货入库列表VO
dataList	配货入库列表		false	array	配货入库AO
dataList	明细行		true	array	配货入库明细AO
omsStockSn	OMS库存流水单号		true	string
qty	商品数量		true	integer
skuCode	SKU编码		true	string
dispatchOrderType	配货订单类型		true	integer
invSerialNo	库存流水单号		true	string
invTime	库存日期		true	string
offStoreCode	入库门店编码		true	string
offStoreName	入库门店名称		true	string
omsInvSerialNo	OMS库存流水单号		false	string
orderCreateTime	单据创建时间		true	string
orderCreator	单据创建人		true	string
tradeNo	交易订单号		false	string
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«配货入库VO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		配货入库VO	配货入库VO
isSuccess	是否成功	boolean
message		string

响应示例:

{
	"code": 0,
	"data": {
		"isSuccess": true
	},
	"message": ""
}

库内存货接口

接口地址:/openApi/bs/invDetail/save

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataList": [
    {
      "financeTypeCode": "",
      "invSerialNo": "",
      "invType": 0,
      "offStoreCode": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderTime": "",
      "qty": 0,
      "remark": "",
      "skuCode": ""
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	库内存货明细列表AO	库内存货明细列表AO
dataList	库内存货明细列表		false	array	库内存货明细AO
financeTypeCode	财务类型代码		false	string
invSerialNo	门店库存流水单据号		false	string
invType	门店出入库类型		false	integer
offStoreCode	门店编码		false	string
orderCreateTime	单据创建时间		false	string
orderCreator	单据创建人		false	string
orderTime	单据日期		false	string
qty	数量		false	integer
remark	备注说明		false	string
skuCode	SKU编码		false	string
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
message		string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

履约订单

接口地址:/openApi/bs/salesOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "dataList": [
    {
      "channelType": 0,
      "consignTime": "",
      "dataList": [
        {
          "midTypeCode": "",
          "midTypeName": "",
          "offStoreFirstCategoryCode": "",
          "offStoreFirstCategoryName": "",
          "qty": 0,
          "salesFaceAmount": 0,
          "salesPrice": 0,
          "salesRealAmount": 0,
          "salesStandardAmount": 0,
          "skuCode": "",
          "smallTypeCode": "",
          "smallTypeName": ""
        }
      ],
      "miniStoreCode": "",
      "offStoreCode": "",
      "orderClass": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderType": 0,
      "originOrderNo": "",
      "payTime": "",
      "salesOrderNo": "",
      "totalFaceAmount": 0,
      "totalRecAmount": 0
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	履约订单AO	履约订单AO
dataList	订单数据行		true	array	SalesOrder
channelType	渠道类型，0:pos、1:旗舰店小程序、2:超级门店小程序、3:美团、4:饿了吗、5:京东到家、6:喵街		true	integer
consignTime	订单发货日期 格式:yyyy-MM-dd HH:mm:ss		true	string
dataList	订单明细行		true	array	SalesOrderDetail
midTypeCode	中类编码		true	string
midTypeName	中类名称		true	string
offStoreFirstCategoryCode	门店一级分类编码		true	string
offStoreFirstCategoryName	门店一级分类名称		true	string
qty	数量		true	integer
salesFaceAmount	销售金额（面值）		true	number
salesPrice	销售单价		true	number
salesRealAmount	销售金额（本金）		true	number
salesStandardAmount	标准销售金额		true	number
skuCode	SKU编码		true	string
smallTypeCode	小类编码		true	string
smallTypeName	小类名称		true	string
miniStoreCode	小程序店铺编码		false	string
offStoreCode	门店编码		true	string
orderClass	订单类别，sales:销售订单、back:退货订单		true	string
orderCreateTime	单据创建时间 格式:yyyy-MM-dd HH:mm:ss		true	string
orderCreator	单据创建人		true	string
orderType	订单类型，0:门店订单、1:预售订单、2:定金订单、3:店定网络订单、4:自提订单、5:门店快递订单、6:渠道订单		true	integer
originOrderNo	原订单号		false	string
payTime	支付日期 格式:yyyy-MM-dd HH:mm:ss		true	string
salesOrderNo	订单编号		true	string
totalFaceAmount	订单总金额（面值）		true	number
totalRecAmount	订单总金额（本金）		true	number
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
message		string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

店铺信息同步

接口地址:/openApi/bs/syncStore

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "cityCode": "",
  "cityName": "",
  "customerCode": "",
  "mainGroupName": "",
  "marketingAreaCode": "",
  "marketingAreaName": "",
  "provinceCode": "",
  "provinceName": "",
  "storeCode": "",
  "storeName": "",
  "storeType": "",
  "storeTypeName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	BsStoreConfigAO	BsStoreConfigAO
cityCode	市编码		false	string
cityName	市名称		false	string
customerCode	客户编码		false	string
mainGroupName	主体名称		true	string
marketingAreaCode	营销区域编码		false	string
marketingAreaName	营销区域名称		false	string
provinceCode	省编码		false	string
provinceName	省名称		false	string
storeCode	店铺编码		true	string
storeName	店铺名称		true	string
storeType	店铺类型 01直营；02联营；03加盟；04批销；05托管		false	string
storeTypeName	店铺类型名称		false	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
message		string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

调拨订单接口

接口地址:/openApi/bs/transferOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "dataList": [
    {
      "dataList": [
        {
          "qty": 0,
          "skuCode": ""
        }
      ],
      "orderCreateTime": "",
      "orderCreator": "",
      "transferInStoreCode": "",
      "transferNo": "",
      "transferOutStoreCode": "",
      "transferOutTime": ""
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	调拨订单列表AO	调拨订单列表AO
dataList	调拨订单列表		false	array	调拨订单AO
dataList	明细行		true	array	调拨订单明细AO
qty	商品数量		true	integer
skuCode	SKU编码		true	string
orderCreateTime	单据创建时间		true	string
orderCreator	单据创建人		true	string
transferInStoreCode	调拨入库门店编码		true	string
transferNo	调拨单号		true	string
transferOutStoreCode	调拨出库门店编码		true	string
transferOutTime	调拨出库日期		true	string
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«调拨订单VO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		调拨订单VO	调拨订单VO
isSuccess	是否成功	boolean
message		string

响应示例:

{
	"code": 0,
	"data": {
		"isSuccess": true
	},
	"message": ""
}

退仓订单接口

接口地址:/openApi/bs/warehouseReturnOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "dataList": [
    {
      "dataList": [
        {
          "omsStockSn": "",
          "qty": 0,
          "skuCode": ""
        }
      ],
      "dispatchOrderNo": "",
      "dispatchOrderType": 0,
      "invSerialNo": "",
      "invTime": "",
      "offStoreCode": "",
      "omsInvSerialNo": "",
      "orderCreateTime": "",
      "orderCreator": ""
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	退仓订单列表AO	退仓订单列表AO
dataList	退仓订单列表		false	array	退仓订单AO
dataList	明细行		true	array	退仓订单明细AO
omsStockSn	OMS库存流水单号		true	string
qty	商品数量		true	integer
skuCode	SKU编码		true	string
dispatchOrderNo	门店配货订单号		true	string
dispatchOrderType	配货订单类型		true	integer
invSerialNo	库存流水单号		true	string
invTime	库存日期		true	string
offStoreCode	入库门店编码		true	string
omsInvSerialNo	OMS库存流水单号		true	string
orderCreateTime	单据创建时间		true	string
orderCreator	单据创建人		true	string
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«退仓订单VO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		退仓订单VO	退仓订单VO
isSuccess	是否成功	boolean
message		string

响应示例:

{
	"code": 0,
	"data": {
		"isSuccess": true
	},
	"message": ""
}

批销订单

接口地址:/openApi/bs/wholeSalesOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

接口描述:

请求示例:

{
  "dataList": [
    {
      "consignTime": "",
      "dataList": [
        {
          "offStoreFirstCategoryCode": "",
          "qty": 0,
          "salesAmount": 0,
          "salesPrice": 0,
          "salesStandardAmount": 0,
          "skuCode": ""
        }
      ],
      "offStoreCode": "",
      "omsSalesOrderNo": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderType": "",
      "outOrderNo": "",
      "payTime": "",
      "salesOrderNo": "",
      "totalAmount": 0,
      "totalQty": 0,
      "verCashAmount": 0,
      "verSupplyAmount": 0,
      "warehouseCode": ""
    }
  ],
  "requestId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	批销订单AO	批销订单AO
dataList	批销订单数据行		true	array	WholeSalesOrder
consignTime	发货日期 格式:yyyy-MM-dd HH:mm:ss		true	string
dataList	批销订单明细行		true	array	WholeSalesOrderDetail
offStoreFirstCategoryCode	门店一级分类编码		true	string
qty	发货数量		true	integer
salesAmount	销售金额		true	number
salesPrice	商品单价		true	number
salesStandardAmount	标准销售金额		true	number
skuCode	SKU编码		true	string
offStoreCode	门店编码		true	string
omsSalesOrderNo	OMS单号		true	string
orderCreateTime	单据创建时间 格式:yyyy-MM-dd HH:mm:ss		true	string
orderCreator	单据创建人		true	string
orderType	订单类型，receive:收款、 back:退款		true	string
outOrderNo	出库单号		true	string
payTime	订单下单日期 格式:yyyy-MM-dd HH:mm:ss		true	string
salesOrderNo	销售订单号		false	string
totalAmount	本次发货总金额		true	number
totalQty	本次发货总数量		true	integer
verCashAmount	现金核销金额		true	number
verSupplyAmount	货补核销金额		true	number
warehouseCode	发货仓库		false	string
requestId	请求id,作为幂等性标识字段		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
message		string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}