# 订单信息

# 获取订单列表

# 接口名称 :

GetTranOrderList

# 接口说明 :

获取订单列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetTranOrderList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
pageIndex	是	integer	└ 当前页，默认从第1页开始
pageSize	是	integer	└ 分页大小，默认50条
schoolId	否	integer	└ 校区id，可选
tranOrderType	是	integer	└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
dateType	是	integer	└ 查询日期类型，1：经办日期，2：创建时间；缺省按经办日期查询
beginDate	是	datetime	└ 搜索开始时间(查询日期类型)，区间跨度最大为一个月。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00
endDate	是	datetime	└ 搜索结束时间(查询日期类型)，区间跨度最大为一个月。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
id	integer	└ 订单id
orderNumber	integer	└ 订单号
stuName	string	└ 学员姓名
stuInfoId	integer	└ 学员ID
type	integer	└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└ 交易内容
shouldPay	number	└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└ 实收/实退，正数表示实收，负数表示实退
remain	number	└ 余额变动
arrearage	number	└ 欠费
hrDocId	integer	└ 经办人ID
hrDocName	string	└ 经办人
tags	object	└ 订单标签
schoolId	integer	└ 经办校区ID
schoolName	string	└ 经办校区
dealDate	datetime	└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└ 销售员
viceSales	string	└ 副销售员
teleMarketing	string	└ 电话销售
purchaser	string	└ 采单员
status	integer	└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└ 销售来源
createdTime	datetime	└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└ 收款账号明细
accountId	integer	└└ 账户id
accountName	string	└└ 账户
oppositeAccount	string	└└ 对方账户
amount	number	└└ 金额
orderNumber	string	└└ 流水号
isConfirm	boolean	└└ 是否到账
tranOrderId	integer	└└ 订单id

请求正文：

{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","schoolId":"@integer(60, 100)","tranOrderType":1,"dateType":1,"beginDate":"@datetime","endDate":"@datetime"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getTranOrderList(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    }
  ]
}

# 获取变更的订单记录

# 接口名称 :

GetChangedOrders

# 接口说明 :

时间范围不能超过7天

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetChangedOrders (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
startTime	是	datetime	└ 开始时间。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00
endTime	是	datetime	└ 结束时间。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
id	integer	└ 订单Id
type	integer	└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
changedTime	datetime	└ 订单变更时间。时间格式示例：2020-01-01T00:00:00

请求正文：

{"startTime":"@datetime","endTime":"@datetime"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getChangedOrders(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "id": "@integer(60, 100)",
      "type": 1,
      "changedTime": "@datetime"
    }
  ]
}

# 获取报名订单详情

# 接口名称 :

GetSignupOrderDetail

# 接口说明 :

获取报名订单详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetSignupOrderDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
id	是	integer	└ 订单Id

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	object	返回数据信息
baseInfo	object	└ 订单基础信息
id	integer	└└ 订单id
orderNumber	integer	└└ 订单号
stuName	string	└└ 学员姓名
stuInfoId	integer	└└ 学员ID
type	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└└ 交易内容
shouldPay	number	└└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└└ 实收/实退，正数表示实收，负数表示实退
remain	number	└└ 余额变动
arrearage	number	└└ 欠费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
tags	object	└└ 订单标签
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└└ 销售员
viceSales	string	└└ 副销售员
teleMarketing	string	└└ 电话销售
purchaser	string	└└ 采单员
status	integer	└└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└└ 销售来源
createdTime	datetime	└└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└└ 收款账号明细
accountId	integer	└└└ 账户id
accountName	string	└└└ 账户
oppositeAccount	string	└└└ 对方账户
amount	number	└└└ 金额
orderNumber	string	└└└ 流水号
isConfirm	boolean	└└└ 是否到账
tranOrderId	integer	└└└ 订单id
signupLessons	array	└ 报读课程列表
feetranId	integer	└└ 报名/转入交易Id
lessonId	integer	└└ 课程Id
lessonName	string	└└ 课程名称
feeMode	integer	└└ 收费模式 1:按课时 2:按时间 3:按期
lessonMode	integer	└└ 课程类型 1:班课 2:一对一
classId	integer	└└ 班级Id
className	string	└└ 班级名称
teacherId	integer	└└ 教师Id
teacherName	string	└└ 教师名称
schoolId	integer	└└ 报读校区
schoolName	string	└└ 报读校区名称
stuFeeDocId	integer	└└ 学费账户Id
enrollType	integer	└└ 报名类型 0. 新报 1. 续费 2. 无 3. 升期 4. 扩科
feeTranType	integer	└└ 学费交易类型 1. 按期缴费 2. 按课时缴费 3. 按时间缴费 4. 转课转入 5. 赠送课时
unitPrice	number	└└ 课程单价
count	number	└└ 一个sku包含的课时/时间数量
skuUnitPrice	number	└└ sku单价
skuCount	number	└└ 购买的sku数量
totalCount	number	└└ 总记录数
unit	integer	└└ 学费单位 1. 元/期 2. 元/课时 3. 元/天 4. 元/月 5. 元/季 6. 元/年
beginDate	datetime	└└ 开始日期（按时间收费）。时间格式示例：2020-01-01T00:00:00
expiryDate	datetime	└└ 结束日期（按时间收费）。时间格式示例：2020-01-01T00:00:00
originAmount	number	└└ 原价格
promotionAmount	number	└└ 优惠金额
tranMarketing	object	└└ 营销活动信息
marketingComment	string	└└└ 活动优惠内容
marketingPromotionAmount	number	└└└ 营销活动优惠的金额
promotionType	integer	└└└ 营销活动类型 0: 非赠送课时；1: 赠送课时类型
feeTranId	integer	└└└ 交易Id
microMartCouponPromotion	object	└└ 优惠券信息
couponId	integer	└└└ 优惠券Id
couponName	string	└└└ 优惠券名称
couponRuleDesc	string	└└└ 优惠券规则描述
apportionPromotionAmount	number	└└└ 实际分摊的优惠金额（非优惠券面额）
feeTranId	integer	└└└ 交易Id
realAmount	number	└└ 应收金额（不含教材杂费子项金额）
arrearage	number	└└ 欠费金额（不含教材杂费子项金额）
actualIncome	number	└└ 实收金额（不含教材杂费子项金额）
comment	string	└└ 对内备注
itemTrans	array	└└ 教材杂费交易对象集合
itemTranId	integer	└└└ 教材杂费交易Id
itemTranType	integer	└└└ 教材杂费交易类型
stuFeeDocId	integer	└└└ 学费账户Id
itemId	integer	└└└ 教材杂项Id
itemName	string	└└└ 教材杂费名称
lessonId	integer	└└└ 课程Id
lessonName	string	└└└ 课程名称
itemGot	boolean	└└└ 是否已领用
unitPrice	number	└└└ 单价
count	number	└└└ 购买数量
realAmount	number	└└└ 应收金额
arrearage	number	└└└ 欠费金额
actualIncome	number	└└└ 实收金额
comment	string	└└└ 对内备注
itemReturn	boolean	└└└ 是否已归还（退费时使用）
purchaseTranOrderId	integer	└└└ 对应的购买订单Id（退费时使用）
purchaseTranOrderType	integer	└└└ 对应的购买订单类型（退费时使用）
purchaseItemTranId	integer	└└└ 对应的购买交易Id（退费时使用）

请求正文：

{"id":"@integer(60, 100)"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getSignupOrderDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": {
    "baseInfo": {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    },
    "signupLessons": [
      {
        "feetranId": "@integer(60, 100)",
        "lessonId": "@integer(60, 100)",
        "lessonName": "@string",
        "feeMode": 1,
        "lessonMode": 1,
        "classId": "@integer(60, 100)",
        "className": "@string",
        "teacherId": "@integer(60, 100)",
        "teacherName": "@string",
        "schoolId": "@integer(60, 100)",
        "schoolName": "@string",
        "stuFeeDocId": "@integer(60, 100)",
        "enrollType": 0,
        "feeTranType": 1,
        "unitPrice": "@integer(60, 100)",
        "count": "@integer(60, 100)",
        "skuUnitPrice": "@integer(60, 100)",
        "skuCount": "@integer(60, 100)",
        "totalCount": "@integer(60, 100)",
        "unit": 2,
        "beginDate": "@datetime",
        "expiryDate": "@datetime",
        "originAmount": "@integer(60, 100)",
        "promotionAmount": "@integer(60, 100)",
        "tranMarketing": {
          "marketingComment": "@string",
          "marketingPromotionAmount": "@integer(60, 100)",
          "promotionType": "@integer(60, 100)",
          "feeTranId": "@integer(60, 100)"
        },
        "microMartCouponPromotion": {
          "couponId": "@integer(60, 100)",
          "couponName": "@string",
          "couponRuleDesc": "@string",
          "apportionPromotionAmount": "@integer(60, 100)",
          "feeTranId": "@integer(60, 100)"
        },
        "realAmount": "@integer(60, 100)",
        "arrearage": "@integer(60, 100)",
        "actualIncome": "@integer(60, 100)",
        "comment": "@string",
        "itemTrans": [
          {
            "itemTranId": "@integer(60, 100)",
            "itemTranType": 1,
            "stuFeeDocId": "@integer(60, 100)",
            "itemId": "@integer(60, 100)",
            "itemName": "@string",
            "lessonId": "@integer(60, 100)",
            "lessonName": "@string",
            "itemGot": "@boolean",
            "unitPrice": "@integer(60, 100)",
            "count": "@integer(60, 100)",
            "realAmount": "@integer(60, 100)",
            "arrearage": "@integer(60, 100)",
            "actualIncome": "@integer(60, 100)",
            "comment": "@string",
            "itemReturn": "@boolean",
            "purchaseTranOrderId": "@integer(60, 100)",
            "purchaseTranOrderType": 1,
            "purchaseItemTranId": "@integer(60, 100)"
          }
        ]
      }
    ]
  }
}

# 获取补费订单详情

# 接口名称 :

GetRepairTranOrderDetail

# 接口说明 :

获取补费订单详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetRepairTranOrderDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
id	是	integer	└ 订单Id

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	object	返回数据信息
baseInfo	object	└ 订单基础信息
id	integer	└└ 订单id
orderNumber	integer	└└ 订单号
stuName	string	└└ 学员姓名
stuInfoId	integer	└└ 学员ID
type	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└└ 交易内容
shouldPay	number	└└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└└ 实收/实退，正数表示实收，负数表示实退
remain	number	└└ 余额变动
arrearage	number	└└ 欠费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
tags	object	└└ 订单标签
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└└ 销售员
viceSales	string	└└ 副销售员
teleMarketing	string	└└ 电话销售
purchaser	string	└└ 采单员
status	integer	└└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└└ 销售来源
createdTime	datetime	└└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└└ 收款账号明细
accountId	integer	└└└ 账户id
accountName	string	└└└ 账户
oppositeAccount	string	└└└ 对方账户
amount	number	└└└ 金额
orderNumber	string	└└└ 流水号
isConfirm	boolean	└└└ 是否到账
tranOrderId	integer	└└└ 订单id
comment	string	└ 对内备注
repairTrans	array	└ 补费交易列表
repairTranId	integer	└└ 补费交易Id
tranOrderId	integer	└└ 对应的欠费订单Id
orderNumber	integer	└└ 对应的欠费订单号
arrearageTranId	integer	└└ 对应的欠费交易Id
arrearageTranName	string	└└ 对应的欠费交易名称
arrearage	number	└└ 对应的欠费金额
orderType	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
repairAmount	number	└└ 补费金额
comment	string	└└ 对内备注

请求正文：

{"id":"@integer(60, 100)"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getRepairTranOrderDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": {
    "baseInfo": {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    },
    "comment": "@string",
    "repairTrans": [
      {
        "repairTranId": "@integer(60, 100)",
        "tranOrderId": "@integer(60, 100)",
        "orderNumber": "@integer(60, 100)",
        "arrearageTranId": "@integer(60, 100)",
        "arrearageTranName": "@string",
        "arrearage": "@integer(60, 100)",
        "orderType": 1,
        "hrDocId": "@integer(60, 100)",
        "hrDocName": "@string",
        "schoolId": "@integer(60, 100)",
        "schoolName": "@string",
        "dealDate": "@datetime",
        "repairAmount": "@integer(60, 100)",
        "comment": "@string"
      }
    ]
  }
}

# 获取账户余额变动订单详情

# 接口名称 :

GetAccountChangeOrderDetail

# 接口说明 :

获取账户余额变动订单详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetAccountChangeOrderDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
id	是	integer	└ 订单Id

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	object	返回数据信息
baseInfo	object	└ 订单基础信息
id	integer	└└ 订单id
orderNumber	integer	└└ 订单号
stuName	string	└└ 学员姓名
stuInfoId	integer	└└ 学员ID
type	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└└ 交易内容
shouldPay	number	└└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└└ 实收/实退，正数表示实收，负数表示实退
remain	number	└└ 余额变动
arrearage	number	└└ 欠费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
tags	object	└└ 订单标签
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└└ 销售员
viceSales	string	└└ 副销售员
teleMarketing	string	└└ 电话销售
purchaser	string	└└ 采单员
status	integer	└└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└└ 销售来源
createdTime	datetime	└└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└└ 收款账号明细
accountId	integer	└└└ 账户id
accountName	string	└└└ 账户
oppositeAccount	string	└└└ 对方账户
amount	number	└└└ 金额
orderNumber	string	└└└ 流水号
isConfirm	boolean	└└└ 是否到账
tranOrderId	integer	└└└ 订单id
accountRemain	number	└ 余额
comment	string	└ 对内备注

请求正文：

{"id":"@integer(60, 100)"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getAccountChangeOrderDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": {
    "baseInfo": {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    },
    "accountRemain": "@integer(60, 100)",
    "comment": "@string"
  }
}

# 获取转课订单详情

# 接口名称 :

GetTurnClassOrderDetail

# 接口说明 :

获取转课订单详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetTurnClassOrderDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
id	是	integer	└ 订单Id

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	object	返回数据信息
baseInfo	object	└ 订单基础信息
id	integer	└└ 订单id
orderNumber	integer	└└ 订单号
stuName	string	└└ 学员姓名
stuInfoId	integer	└└ 学员ID
type	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└└ 交易内容
shouldPay	number	└└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└└ 实收/实退，正数表示实收，负数表示实退
remain	number	└└ 余额变动
arrearage	number	└└ 欠费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
tags	object	└└ 订单标签
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└└ 销售员
viceSales	string	└└ 副销售员
teleMarketing	string	└└ 电话销售
purchaser	string	└└ 采单员
status	integer	└└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└└ 销售来源
createdTime	datetime	└└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└└ 收款账号明细
accountId	integer	└└└ 账户id
accountName	string	└└└ 账户
oppositeAccount	string	└└└ 对方账户
amount	number	└└└ 金额
orderNumber	string	└└└ 流水号
isConfirm	boolean	└└└ 是否到账
tranOrderId	integer	└└└ 订单id
turnOutLessons	array	└ 转出课程
transforTranId	integer	└└ 退费/转出交易id
purchaseTranOrderId	integer	└└ 对应的转入/报名订单Id
purchaseTranOrderType	integer	└└ 对应的转入/报名订单类型
purchaseFeetranId	integer	└└ 对应的报名/转入交易Id
lessonId	integer	└└ 课程Id
lessonName	string	└└ 课程名称
transforTranType	integer	└└ 退费交易类型 1. 转课转出 2. 办理退费 3. 部分退费 6. 转课手续费 7. 退费手续费 10. 部分转出
classtimes	number	└└ 退费课时/天数
amount	number	└└ 退费金额
comment	string	└└ 对内备注
turnInLesson	object	└ 转入课程
feetranId	integer	└└ 报名/转入交易Id
lessonId	integer	└└ 课程Id
lessonName	string	└└ 课程名称
feeMode	integer	└└ 收费模式 1:按课时 2:按时间 3:按期
lessonMode	integer	└└ 课程类型 1:班课 2:一对一
classId	integer	└└ 班级Id
className	string	└└ 班级名称
teacherId	integer	└└ 教师Id
teacherName	string	└└ 教师名称
schoolId	integer	└└ 报读校区
schoolName	string	└└ 报读校区名称
stuFeeDocId	integer	└└ 学费账户Id
enrollType	integer	└└ 报名类型 0. 新报 1. 续费 2. 无 3. 升期 4. 扩科
feeTranType	integer	└└ 学费交易类型 1. 按期缴费 2. 按课时缴费 3. 按时间缴费 4. 转课转入 5. 赠送课时
unitPrice	number	└└ 课程单价
count	number	└└ 一个sku包含的课时/时间数量
skuUnitPrice	number	└└ sku单价
skuCount	number	└└ 购买的sku数量
totalCount	number	└└ 总记录数
unit	integer	└└ 学费单位 1. 元/期 2. 元/课时 3. 元/天 4. 元/月 5. 元/季 6. 元/年
beginDate	datetime	└└ 开始日期（按时间收费）。时间格式示例：2020-01-01T00:00:00
expiryDate	datetime	└└ 结束日期（按时间收费）。时间格式示例：2020-01-01T00:00:00
originAmount	number	└└ 原价格
promotionAmount	number	└└ 优惠金额
tranMarketing	object	└└ 营销活动信息
marketingComment	string	└└└ 活动优惠内容
marketingPromotionAmount	number	└└└ 营销活动优惠的金额
promotionType	integer	└└└ 营销活动类型 0: 非赠送课时；1: 赠送课时类型
feeTranId	integer	└└└ 交易Id
microMartCouponPromotion	object	└└ 优惠券信息
couponId	integer	└└└ 优惠券Id
couponName	string	└└└ 优惠券名称
couponRuleDesc	string	└└└ 优惠券规则描述
apportionPromotionAmount	number	└└└ 实际分摊的优惠金额（非优惠券面额）
feeTranId	integer	└└└ 交易Id
realAmount	number	└└ 应收金额（不含教材杂费子项金额）
arrearage	number	└└ 欠费金额（不含教材杂费子项金额）
actualIncome	number	└└ 实收金额（不含教材杂费子项金额）
comment	string	└└ 对内备注
itemTrans	array	└└ 教材杂费交易对象集合
itemTranId	integer	└└└ 教材杂费交易Id
itemTranType	integer	└└└ 教材杂费交易类型
stuFeeDocId	integer	└└└ 学费账户Id
itemId	integer	└└└ 教材杂项Id
itemName	string	└└└ 教材杂费名称
lessonId	integer	└└└ 课程Id
lessonName	string	└└└ 课程名称
itemGot	boolean	└└└ 是否已领用
unitPrice	number	└└└ 单价
count	number	└└└ 购买数量
realAmount	number	└└└ 应收金额
arrearage	number	└└└ 欠费金额
actualIncome	number	└└└ 实收金额
comment	string	└└└ 对内备注
itemReturn	boolean	└└└ 是否已归还（退费时使用）
purchaseTranOrderId	integer	└└└ 对应的购买订单Id（退费时使用）
purchaseTranOrderType	integer	└└└ 对应的购买订单类型（退费时使用）
purchaseItemTranId	integer	└└└ 对应的购买交易Id（退费时使用）

请求正文：

{"id":"@integer(60, 100)"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getTurnClassOrderDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": {
    "baseInfo": {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    },
    "turnOutLessons": [
      {
        "transforTranId": "@integer(60, 100)",
        "purchaseTranOrderId": "@integer(60, 100)",
        "purchaseTranOrderType": 1,
        "purchaseFeetranId": "@integer(60, 100)",
        "lessonId": "@integer(60, 100)",
        "lessonName": "@string",
        "transforTranType": 1,
        "classtimes": "@integer(60, 100)",
        "amount": "@integer(60, 100)",
        "comment": "@string"
      }
    ],
    "turnInLesson": {
      "feetranId": "@integer(60, 100)",
      "lessonId": "@integer(60, 100)",
      "lessonName": "@string",
      "feeMode": 1,
      "lessonMode": 1,
      "classId": "@integer(60, 100)",
      "className": "@string",
      "teacherId": "@integer(60, 100)",
      "teacherName": "@string",
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "stuFeeDocId": "@integer(60, 100)",
      "enrollType": 0,
      "feeTranType": 1,
      "unitPrice": "@integer(60, 100)",
      "count": "@integer(60, 100)",
      "skuUnitPrice": "@integer(60, 100)",
      "skuCount": "@integer(60, 100)",
      "totalCount": "@integer(60, 100)",
      "unit": 2,
      "beginDate": "@datetime",
      "expiryDate": "@datetime",
      "originAmount": "@integer(60, 100)",
      "promotionAmount": "@integer(60, 100)",
      "tranMarketing": {
        "marketingComment": "@string",
        "marketingPromotionAmount": "@integer(60, 100)",
        "promotionType": "@integer(60, 100)",
        "feeTranId": "@integer(60, 100)"
      },
      "microMartCouponPromotion": {
        "couponId": "@integer(60, 100)",
        "couponName": "@string",
        "couponRuleDesc": "@string",
        "apportionPromotionAmount": "@integer(60, 100)",
        "feeTranId": "@integer(60, 100)"
      },
      "realAmount": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "actualIncome": "@integer(60, 100)",
      "comment": "@string",
      "itemTrans": [
        {
          "itemTranId": "@integer(60, 100)",
          "itemTranType": 1,
          "stuFeeDocId": "@integer(60, 100)",
          "itemId": "@integer(60, 100)",
          "itemName": "@string",
          "lessonId": "@integer(60, 100)",
          "lessonName": "@string",
          "itemGot": "@boolean",
          "unitPrice": "@integer(60, 100)",
          "count": "@integer(60, 100)",
          "realAmount": "@integer(60, 100)",
          "arrearage": "@integer(60, 100)",
          "actualIncome": "@integer(60, 100)",
          "comment": "@string",
          "itemReturn": "@boolean",
          "purchaseTranOrderId": "@integer(60, 100)",
          "purchaseTranOrderType": 1,
          "purchaseItemTranId": "@integer(60, 100)"
        }
      ]
    }
  }
}

# 获取退费订单详情

# 接口名称 :

GetRefundMoneryOrderDetail

# 接口说明 :

获取退费订单详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetRefundMoneryOrderDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
id	是	integer	└ 订单Id

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	object	返回数据信息
baseInfo	object	└ 订单基础信息
id	integer	└└ 订单id
orderNumber	integer	└└ 订单号
stuName	string	└└ 学员姓名
stuInfoId	integer	└└ 学员ID
type	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└└ 交易内容
shouldPay	number	└└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└└ 实收/实退，正数表示实收，负数表示实退
remain	number	└└ 余额变动
arrearage	number	└└ 欠费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
tags	object	└└ 订单标签
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└└ 销售员
viceSales	string	└└ 副销售员
teleMarketing	string	└└ 电话销售
purchaser	string	└└ 采单员
status	integer	└└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└└ 销售来源
createdTime	datetime	└└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└└ 收款账号明细
accountId	integer	└└└ 账户id
accountName	string	└└└ 账户
oppositeAccount	string	└└└ 对方账户
amount	number	└└└ 金额
orderNumber	string	└└└ 流水号
isConfirm	boolean	└└└ 是否到账
tranOrderId	integer	└└└ 订单id
comment	string	└ 对内备注
refundLessons	array	└ 退费课程
transforTranId	integer	└└ 退费/转出交易id
purchaseTranOrderId	integer	└└ 对应的转入/报名订单Id
purchaseTranOrderType	integer	└└ 对应的转入/报名订单类型
purchaseFeetranId	integer	└└ 对应的报名/转入交易Id
lessonId	integer	└└ 课程Id
lessonName	string	└└ 课程名称
transforTranType	integer	└└ 退费交易类型 1. 转课转出 2. 办理退费 3. 部分退费 6. 转课手续费 7. 退费手续费 10. 部分转出
classtimes	number	└└ 退费课时/天数
amount	number	└└ 退费金额
comment	string	└└ 对内备注

请求正文：

{"id":"@integer(60, 100)"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getRefundMoneryOrderDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": {
    "baseInfo": {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    },
    "comment": "@string",
    "refundLessons": [
      {
        "transforTranId": "@integer(60, 100)",
        "purchaseTranOrderId": "@integer(60, 100)",
        "purchaseTranOrderType": 1,
        "purchaseFeetranId": "@integer(60, 100)",
        "lessonId": "@integer(60, 100)",
        "lessonName": "@string",
        "transforTranType": 1,
        "classtimes": "@integer(60, 100)",
        "amount": "@integer(60, 100)",
        "comment": "@string"
      }
    ]
  }
}

# 获取教材杂费订单详情

# 接口名称 :

GetItemTranOrderDetail

# 接口说明 :

获取教材杂费订单详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetItemTranOrderDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
id	是	integer	└ 订单Id

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	object	返回数据信息
baseInfo	object	└ 订单基础信息
id	integer	└└ 订单id
orderNumber	integer	└└ 订单号
stuName	string	└└ 学员姓名
stuInfoId	integer	└└ 学员ID
type	integer	└└ 订单类型，1：报名，2：账户余额变动，3：转课，6：结课，7：退费，8：教材杂费，9：积分，10：补费
content	string	└└ 交易内容
shouldPay	number	└└ 应收/应退，正数表示应收，负数表示应退
realPay	number	└└ 实收/实退，正数表示实收，负数表示实退
remain	number	└└ 余额变动
arrearage	number	└└ 欠费
hrDocId	integer	└└ 经办人ID
hrDocName	string	└└ 经办人
tags	object	└└ 订单标签
schoolId	integer	└└ 经办校区ID
schoolName	string	└└ 经办校区
dealDate	datetime	└└ 经办日期。时间格式示例：2020-01-01T00:00:00
seller	string	└└ 销售员
viceSales	string	└└ 副销售员
teleMarketing	string	└└ 电话销售
purchaser	string	└└ 采单员
status	integer	└└ 状态，1：待支付，2：已完成，3：已作废，4：已失效
salesSource	string	└└ 销售来源
createdTime	datetime	└└ 创建时间。时间格式示例：2020-01-01T00:00:00
sourceType	integer	└└ 订单来源 1：线下办理，2：校宝秀，3：导入，4,：校宝家，5：线上办理
accountDetails	array	└└ 收款账号明细
accountId	integer	└└└ 账户id
accountName	string	└└└ 账户
oppositeAccount	string	└└└ 对方账户
amount	number	└└└ 金额
orderNumber	string	└└└ 流水号
isConfirm	boolean	└└└ 是否到账
tranOrderId	integer	└└└ 订单id
comment	string	└ 对内备注
itemTrans	array	└ 教材杂费列表
itemTranId	integer	└└ 教材杂费交易Id
itemTranType	integer	└└ 教材杂费交易类型
stuFeeDocId	integer	└└ 学费账户Id
itemId	integer	└└ 教材杂项Id
itemName	string	└└ 教材杂费名称
lessonId	integer	└└ 课程Id
lessonName	string	└└ 课程名称
itemGot	boolean	└└ 是否已领用
unitPrice	number	└└ 单价
count	number	└└ 购买数量
realAmount	number	└└ 应收金额
arrearage	number	└└ 欠费金额
actualIncome	number	└└ 实收金额
comment	string	└└ 对内备注
itemReturn	boolean	└└ 是否已归还（退费时使用）
purchaseTranOrderId	integer	└└ 对应的购买订单Id（退费时使用）
purchaseTranOrderType	integer	└└ 对应的购买订单类型（退费时使用）
purchaseItemTranId	integer	└└ 对应的购买交易Id（退费时使用）

请求正文：

{"id":"@integer(60, 100)"}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getItemTranOrderDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": {
    "baseInfo": {
      "id": "@integer(60, 100)",
      "orderNumber": "@integer(60, 100)",
      "stuName": "@string",
      "stuInfoId": "@integer(60, 100)",
      "type": 1,
      "content": "@string",
      "shouldPay": "@integer(60, 100)",
      "realPay": "@integer(60, 100)",
      "remain": "@integer(60, 100)",
      "arrearage": "@integer(60, 100)",
      "hrDocId": "@integer(60, 100)",
      "hrDocName": "@string",
      "tags": {
        "additionalProp1": "@string",
        "additionalProp2": "@string",
        "additionalProp3": "@string"
      },
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "dealDate": "@datetime",
      "seller": "@string",
      "viceSales": "@string",
      "teleMarketing": "@string",
      "purchaser": "@string",
      "status": 1,
      "salesSource": "@string",
      "createdTime": "@datetime",
      "sourceType": 1,
      "accountDetails": [
        {
          "accountId": "@integer(60, 100)",
          "accountName": "@string",
          "oppositeAccount": "@string",
          "amount": "@integer(60, 100)",
          "orderNumber": "@string",
          "isConfirm": "@boolean",
          "tranOrderId": "@integer(60, 100)"
        }
      ]
    },
    "comment": "@string",
    "itemTrans": [
      {
        "itemTranId": "@integer(60, 100)",
        "itemTranType": 1,
        "stuFeeDocId": "@integer(60, 100)",
        "itemId": "@integer(60, 100)",
        "itemName": "@string",
        "lessonId": "@integer(60, 100)",
        "lessonName": "@string",
        "itemGot": "@boolean",
        "unitPrice": "@integer(60, 100)",
        "count": "@integer(60, 100)",
        "realAmount": "@integer(60, 100)",
        "arrearage": "@integer(60, 100)",
        "actualIncome": "@integer(60, 100)",
        "comment": "@string",
        "itemReturn": "@boolean",
        "purchaseTranOrderId": "@integer(60, 100)",
        "purchaseTranOrderType": 1,
        "purchaseItemTranId": "@integer(60, 100)"
      }
    ]
  }
}

# 学员余额账户充值

# 接口名称 :

RechargeAccountTran

# 接口说明 :

学员余额账户充值

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/RechargeAccountTran (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
stuInfoId	是	integer	└ 学员Id
rechargeAmount	是	number	└ 充值金额,限制0.01~99999999
comment	否	string	└ 对内备注
commentOuter	否	string	└ 对外备注
schoolId	是	integer	└ 经办校区Id
sellerId	否	integer	└ 销售员Id
operatorId	是	integer	└ 经办人ID
dealDate	是	datetime	└ 经办日期，默认当日，时间格式示例：2020-01-01T00:00:00
accountInfos	是	array	└ 账户
accountName	是	string	└─ 账户名称
amount	是	number	└─ 账户金额
comment	否	string	└─ 备注
oppositeAccount	否	string	└─ 对方账户
orderNumber	否	string	└─ 流水单号
simplePaymentMethodTradeNo	否	string	└─ 支付单号后8位
tags	否	array	└ 订单标签集合（string）

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	integer	返回数据信息

请求正文：

{"stuInfoId":"@integer(60, 100)","rechargeAmount":"@integer(60, 100)","comment":"@string","commentOuter":"@string","schoolId":"@integer(60, 100)","sellerId":"@integer(60, 100)","operatorId":"@integer(60, 100)","dealDate":"@datetime","accountInfos":[{"accountName":"@string","amount":"@integer(60, 100)","comment":"@string","oppositeAccount":"@string","orderNumber":"@string","simplePaymentMethodTradeNo":"@string"}],"tags":["@string"]}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.rechargeAccountTran(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": "@integer(60, 100)"
}

# 学员余额账户退款

# 接口名称 :

RefundAccountTran

# 接口说明 :

学员余额账户退款

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/RefundAccountTran (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

POST

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
stuInfoId	是	integer	└ 学员Id
refundAmount	是	number	└ 退款金额,限制0.01~99999999
comment	否	string	└ 对内备注
commentOuter	否	string	└ 对外备注
schoolId	是	integer	└ 经办校区Id
sellerId	否	integer	└ 销售员Id
operatorId	是	integer	└ 经办人ID
dealDate	是	datetime	└ 经办日期为当日，日期不同以系统经办日期为准，时间格式示例：2020-01-01T00:00:00
accountInfos	是	array	└ 账户
accountName	是	string	└─ 账户名称
amount	是	number	└─ 账户金额
comment	否	string	└─ 备注
oppositeAccount	否	string	└─ 对方账号
orderNumber	否	string	└─ 流水单号
simplePaymentMethodTradeNo	否	string	└─ 支付单号后8位
tags	否	array	└ 订单标签集合（string）

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	integer	返回数据信息

请求正文：

{"stuInfoId":"@integer(60, 100)","refundAmount":"@integer(60, 100)","comment":"@string","commentOuter":"@string","schoolId":"@integer(60, 100)","sellerId":"@integer(60, 100)","operatorId":"@integer(60, 100)","dealDate":"@datetime","accountInfos":[{"accountName":"@string","amount":"@integer(60, 100)","comment":"@string","oppositeAccount":"@string","orderNumber":"@string","simplePaymentMethodTradeNo":"@string"}],"tags":["@string"]}

请求示例（Java SDK，即将开放，敬请期待）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.refundAccountTran(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": "@integer(60, 100)"
}

← 学员信息上课记录信息 →