# inv

**Repository Path**: xharx/inv

## Basic Information

- **Project Name**: inv
- **Description**: 获取金蝶K/3 Cloud物料库存接口
- **Primary Language**: Visual Basic
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-05-23
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 金蝶K/3Cloud与大商创对接接口

------

- [接口简介](#接口简介)
- [接口说明](#接口说明)
- [按大商创商品编码获取即时库存](#按大商创商品编码获取即时库存)
- [按金蝶物料编码获取即时库存](#按金蝶物料编码获取即时库存)
- [获取指定日期之后创建的金蝶商品列表](#获取指定日期之后创建的金蝶商品列表)
- [向金蝶同步客户](#向金蝶同步客户)
- [向金蝶同步销售订单](#向金蝶同步销售订单)

## 接口简介

本文档为金蝶K/3Cloud（后更名为金蝶云，以下统一称为“金蝶云”）与大商创基础资料和业务单据对接WebAPI接口技术文档。
1. 通过提交大商创商品编码获取金蝶ERP系统的对应物料的即时库存；
2. 通过提交金蝶ERP系统的物料编码获取即时库存；
3. 获取指定日期（含）之后创建的金蝶商品列表；
4. 大商创会员写入金蝶云客户档案，实现客户档案同步；
5. 大商创销售订单同步写入到金蝶云销售订单，实现销售数据同步<br/>

- **Token**:访问授权码，由系统管理员直接在金蝶云里设定。

- **接口地址**：http://服务器IP:端口号/wm/api

## 接口说明

所有接口以RESTful的方式访问，参数及返回值均为采用UTF-8编码的标准JSON格式字符串。

## 按大商创商品编码获取即时库存

**简要描述：** 按大商创系统商品编码，查询该编码对应的金蝶云物料，然后返回该物料的即时库存信息。

**请求 URL：** `/inventory`

**请求方式：** POST

**请求参数：**

``` java
{
    "Code":"1099",                                    //大商创系统的商品编码
    "Token":"66666555-1234-5678-9900-1234ABCD0987"    //访问授权码
}
```

**返回串及字段说明**

``` java
{
    "Material": {
        "Number": "01.01.12024",                      //金蝶ERP的物料编码
        "Code": "1099",                               //大商创系统的商品编码
        "Name": "美的空调KFR-120LW/SDY-PA400(D3)",     //金蝶ERP的物料名称
        "Model": "美的空调KFR-120LW/SDY-PA400(D3)",    //金蝶ERP的物料规格型号
        "Unit": "套",                                 //金蝶ERP的物料计量单位
        "Inventory": [                                //即时库存，列表形式，返回该物料在所有仓库的即时库存，对应计量单位为Unit
            {
                "Warehouse": "恒美本部库",             //仓库名称
                "Value": 30                           //即时库存
            }
        ]
    },
    "Result": 1,                                      //接口执行结果，1为成功，其他值为失败 
    "Message": ""                                     //接口执行结果描述，成功时为空白，失败时为具体失败原因
}
```


## 按金蝶物料编码获取即时库存

**简要描述：** 按金蝶云物料编码获取即时库存。

**请求 URL：** `/inventory2`

**请求方式：** POST

**请求参数：**

``` java
{
    "Number":"102.4.00002",
    "Token":"66666555-1234-5678-9900-1234ABCD0987"
}
```

**返回串及字段说明**

``` java
{
    "Material": {
        "Number": "102.4.00002",
        "Code": "",
        "Name": "海尔中央空调RFUMD140MX-B内机",
        "Model": "RFUMD140MX-B内机",
        "Unit": "台",
        "Inventory": [
            {
                "Warehouse": "2号仓库",
                "Value": 1
            },
            {
                "Warehouse": "东城一品",
                "Value": 4
            }
        ]
    },
    "Result": 1,
    "Message": ""
}
```


## 获取指定日期之后创建的金蝶商品列表

**简要描述：** 获取金蝶云指定日期（含）之后所创建的商品列表。

**请求 URL：** `/goods`

**请求方式：** POST

**请求参数：**

```java
{
    "Date":"2019-06-01",                               //日期，字符型数据，必须为yyyy-mm-dd格式，其他格式会返回错误
    "Token":"66666555-1234-5678-9900-1234ABCD0987"
}
```

**返回串及字段说明**

```java
{
    "Goods": [                                                            //商品列表
        {
            "Code": "AA9ZQL007",                                          //商品编码
            "Name": "海尔家用空调KFR-35GW/15DIB23AU1套机D1.5P变频白",       //商品名称
            "Specification": "KFR-35GW/15DIB23AU1"                        //商品规格
        },
        {
            "Code": "AAA9J4005",
            "Name": "海尔家用空调KFR-35GW/A1YCAA21AU1套机挂机1.5P变频白",
            "Specification": "KFR-35GW/A1YCAA21AU1"
        }
    ],
    "Result": 1,
    "Message": "读取金蝶商品列表成功"
}
```

## 向金蝶同步客户

**简要描述：** 将大商创系统的会员等信息同步写入到金蝶云的客户档案，并自动提交、审核。

**请求 URL：** `/customer`

**请求方式：** POST

**请求参数：**

```java
{
	"Code":"1001.01",                                     //大商创系统的客户编码，必填项
	"Name":"尼古拉斯赵四",                                 //大商创系统的客户名称，必填项
	"TaxNumber":"",                                       //该客户的统一社会信用代码，如为个人，则提供身份证号。非必填项
	"Phone":"13939393939",                                //联系电话，非必填项
	"Exp":"备注信息",                                      //备注，非必填项
    "Extension":"",                                       //其他扩展信息，非必填项。与备注保存在一起
	"Token":"66666555-1234-5678-9900-1234ABCD0987"        //Token
}
```

**返回串及字段说明**

- 调用成功返回
```java
{
    "K3Message": {
        "Result": {
            "ResponseStatus": {
                "IsSuccess": true,               //同步是否成功：true成功，false失败
                "Errors": []                     //如果同步失败，此处记录失败的原因
            },
            "Id": 201868                         //同步成功后的客户在金蝶系统中的内码
        }
    },
    "Result": 201868,                            //同步成功后的客户在金蝶系统中的内码。小于或等于0，说明同步失败
    "Message": ""
}
```

- 调用失败返回
```java
{
    "K3Message": {
        "Result": {
            "ResponseStatus": {
                "IsSuccess": false,
                "Errors": [
                    {
                        "FieldName": "FName",                 //导致同步失败的字段
                        "Message": "字段“客户名称”是必填项",    //同步失败的原因
                        "DIndex": 0
                    }
                ]
            },
            "Id": ""
        }
    },
    "Result": 0,
    "Message": ""
}
```

## 向金蝶同步销售订单

**简要描述：** 将大商创系统的网络订单信息同步写入到金蝶云的销售订单。本接口仅保存单据，不做自动的提交和审核处理。由人工在金蝶云里进行提交、审核的后续操作。

**请求 URL：** `/so`

**请求方式：** POST

**请求参数：**

```java
{
	"BillNo":"Test201907300001",                         //大商创销售订单编号，可以为空字符串，金蝶云将按照金蝶编码规则自动生成销售订单编号
	"Date":"2019-07-30",                                 //大商创销售订单日期
	"CustCode":"01101",                                  //会员编码（此编码与金蝶云客户编码一致，由customer接口实现同步
	"CustTel":"13939393939",                             //会员联系方式，非必填项
	"CustAddress":"会员收货地址信息在这里手工录入",         //会员收货地址，非必填项
	"Explanation":"备注信息",                             //单据备注，非必填项
	"Details":[                                          //订单购货信息明细
		{
			"GoodCode":"CEAAJM01B",                      //商品编码，由大商创根据物料编码对应表转换为金蝶云商品编码
			"Quantity":1,                                //购买数量
			"IsFree":false,                              //是否赠品，true为赠品，false为正常销售商品 
			"PriceWithTax":2500,                         //含税单价，税率由金蝶云的商品档案体现
			"Amount":2500,                               //含税销售金额
			"Note":"这是行备注"                           //行备注，非必填项
		}
	],
	"Token":"7182EC1E-B97B-4961-BBD4-79926E1D4DC6"       //Token
}
```

**返回串及字段说明**

- 调用成功返回
```java
{
    "K3Message": {
        "Result": {
            "ResponseStatus": {
                "IsSuccess": true,                            //调用成功返回true
                "Errors": [],
                "SuccessEntitys": [
                    {
                        "Id": 109504,
                        "Number": "Test201907300001",
                        "DIndex": 0
                    }
                ]
            },
            "Id": 109504,                                     //同步至金蝶云的销售订单内码
            "Number": "Test201907300001"                      //同步至金蝶云的销售订单编码，如果大商创未提供编码，则此处返回按照金蝶编码规则自动生成销售订单编号
        }
    },
    "Result": 109504,                                         //同步成功，此值为订单内码；失败为0或负值
    "Message": "销售订单[Test201907300001]成功同步到金蝶云。"   //同步消息
}
```

- 调用失败返回
```java
{
    "K3Message": {
        "Result": {
            "ResponseStatus": {
                "IsSuccess": false,                                                        //调用失败返回false
                "Errors": [                                                                //具体失败原因列表
                    {
                        "FieldName": "FMaterialId",
                        "Message": "单据体“订单明细”第1行字段“物料编码”是必填项",
                        "DIndex": 0
                    },
                    {
                        "FieldName": "FReceivePlanAmount",
                        "Message": "整单收款计划应收金额合计不等于整单价税合计，不允许保存。",
                        "DIndex": 0
                    }
                ],
                "SuccessEntitys": []
            },
            "Id": "",
            "Number": null
        }
    },
    "Result": 0,
    "Message": "销售订单同步失败,请根据Error字段显示的错误原因进行处理"
}
```