API文档

现付账接口

接口列表

接口名称 接口方法 说明
1.查询现付账套 CashingBill.SearchCashingBills 查询现付账套
2.添加现付账套 CashingBill.AddCashingBill 添加现付账套
3.添加现付账 CashingBill.AddCashingBillItem 添加现付账

1.查询现付账套

CashingBill.SearchCashingBills

应用场景

查询现付账套

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
现付账套Id CashingBillId 否 long?

示例

                        {
     "ChannelKey": "web",
     "Method": "CashingBill.SearchCashingBills",
     "BizContent":"{\"OrgId\":2147483644,\"CashingBillId\":2147483402}",
     "Sign": "C0CE48AC8DD0A69B8225F89B160EA434",
     "SignType": "MD5",
     "Format": "json",
     "Charset": "utf-8",
     "Version": "1.0",
     "Timestamp": "2017-12-18 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgId":2147483644,
    "CashingBillId":2147483402
}

返回结果

字段名 变量名 必填 类型 示例值 描述
现付帐账套Id Id 是 long
现付帐账套名称 Name 是 string
消费科目 BillProjects 是 string[]
账务Id BillId 是 long

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        {
            "Id": 2147483402,
            "Name": "会员卡现付账",
            "BillProjects": [
                "D7500"
            ],
            "BillId": 2147483403
        }
    ]
}

2.添加现付账套

CashingBill.AddCashingBill

应用场景

添加现付账套

请求参数

字段名 变量名 必填 类型 示例值 描述
账套名称 Name 是 string
对应的科目代码 BillProjects 是 string[]
酒店Id OrgId 是 long

示例

{
    "ChannelKey": "web",
    "Method": "CashingBill.AddCashingBill",
    "BizContent":"{\"Name\":\"小商品现付账\",\"BillProjects\":[\"D6500\"],\"OrgId\":2147483644}",
    "Sign": "5B31BE71F643313AAA0CE2CF7D658542",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-12-18 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    \"Name\":\"小商品现付账\",
    \"BillProjects\":[\"D6500\"],
    \"OrgId\":2147483644
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool true 返回成功或失败

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": true
}

3.添加现付账

CashingBill.AddCashingBillItem

应用场景

添加现付账

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
应付帐账套Id CashingBillId 是 long
科目Id BillProjectId 是 string 如：D6500 消费科目代码 见数据字典
金额 Amount 是 decimal
付款科目字符串 BillCreditTypeString 是 string
小商品 SmallWareOrders 是 SmallWareOrderItem[]
付款条目 CreditItem 是 CashingBillItemDetailAddModel
备注 Memo 是 string
总金额 TotalAmount 否 decimal
会员卡充值活动ID ConfigId 否 int

SmallWareOrderItem

字段名 变量名 必填 类型 示例值 描述
小商品Id GoodsId 是 string
商品编号 GoodsNo 是 string
商品名称 GoodsName 是 string
商品数量 Count 是 int
商品价格 Price 是 decimal

CashingBillItemDetailAddModel

字段名 变量名 必填 类型 示例值 描述
账套Id BillId 否 long 当时小商品消费，传入房账ID，消息提示会显示间号，不填写则使用备注提示
科目类别 ItemCategory 是 string 消费科目代码 见数据字典
账务类别 ItemType 是 string Debit消费，Credit付款
账务科目 SubItemType 是 String 见数据字典，账务科目
是否押金 IsDeposit 是 bool
金额 Amount 是 decimal
摘要 Memo 是 string
支付的额外信息 PaymentModel 是 PaymentModel 请参照 PaymentModel，非会员相关操作无需传入

PaymentModel

支付信息备注

  1. ◆ C9120：BankKey，CardNumber，AuthorizeId，BeginValidTime，EndValidTime 必填
  2. ◆ C9150：如果MemberId有值则在支付过程中自动扣除积分，否则请先手动扣除积分，Amount必填
  3. ◆ C9130：如果MemberId有值则在支付过程中自动扣除储值，否则请先手动扣除储值，Amount必填
  4. ◆ C9240：OnlinePaymentId必填
字段名 变量名 必填 类型 示例值 描述
Ar账账套Id ArAccountId 否 long
Ar帐套名称 ArAccountName 否 string 当未提供ArAccountId时，会根据ArAccountName查找ArAccountId
银行编号 BankKey 否 string 入账科目为：C9120 必填
支票 ChequeNumber 否 string
卡号 CardNumber 否 string 入账科目为：C9120 必填
授权号 AuthorizeId 否 string 入账科目为：C9120 必填
有效期开始时间 BeginValidTime 否 DateTime 入账科目为：C9120 必填
有效期结束时间 EndValidTime 否 DateTime 入账科目为：C9120 必填
在线支付Id OnlinePaymentId 否 long 入账科目为：C9240 必填
备注 Memo 否 string
金额 Amount 否 decimal 入账科目为：C9150、C9130、并MemberId为空，必填
会员Id MemberId 否 string
费用类型 FeeType 否 string
会员名称 MemberName 否 string
电话 Mobile 否 string
卡号 MemberCardId 否 string
外卡号 ExtCardNo 否 string

示例

{
    "ChannelKey":"web",
    "Method":"CashingBill.AddCashingBillItem",
    "BizContent":"{\"OrgId\":660247752032257,\"CashingBillId\":660247919804422,
    \"BillProjectId\":\"D7900\",\"Amount\":32.47,\"BillCreditTypeString\":\"C9110\",
    \"CreditItem\":{\"ItemCategory\":\"A\",\"ItemType\":\"Credit\",\"SubItemType\":\"C9110\",
    \"IsDeposit\":false,\"Amount\":32.47,\"PaymentModel\":{\"ArAccountId\":0,\"OnlinePaymentId\":0,
    \"Amount\":32.47,\"MemberId\":\"101517429\"}},\"Memo\":\"\",\"TotalAmount\":32.47}",
    "Sign":"8EB4D0F9FEAC2E52D8D83F554F4CEBDA",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgId":660247752032257,
    "CashingBillId":660247919804422,
    "BillProjectId":"D7900",
    "Amount":32.47,
    "BillCreditTypeString":"C9110",
    "CreditItem":{
        "ItemCategory":"A",
        "ItemType":"Credit",
        "SubItemType":"C9110",
        "IsDeposit":false,
        "Amount":32.47,
        "PaymentModel":{
            "ArAccountId":0,
            "OnlinePaymentId":0,
            "Amount":32.47,
            "MemberId":"101517429"
        }
    },
    "Memo":"",
    "TotalAmount":32.47
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool true 返回成功或失败

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": true
}

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 bill.member-recharge-error 会员充值失败
bill.member-card-not-found 未找到会员卡信息
bill.need-scan-qr-code 请先刷新二维码
bill.need-scan-bar-code 请先刷新条形码