患者还款 - 方软OpenApi-机构版

请求参数

Header 参数

FRHis-Open-Timestamp

string

必需

示例值:

{% mock 'timestamp' %}

FRHis-Open-App-Id

string

必需

示例值:

FRHis-Open-Token

string

必需

示例值:

Body 参数application/json

patientID

integer

患者id

必需

repayAmount

number

还款金额

必需

还款金额=实际还款+平台服务费扣除。“平台服务费扣除”主要针对三方平台欠款。存在患者通过线上三方平台预购项目的情况，患者需在线上预付一部分款项，到院后只需支付余下部分，那患者在线上预付的那部分金额就只能做成三方欠款。当三方平台实际返还患者预付款给医院时会扣除一部分服务费或佣金。

actualRepayAmount

number

实际还款

必需

医院实际收到的钱。对于个人还款“实际还款”等于“还款金额”，对于三方线上平台，则指的是平台剔除服务后实际返还给医院的钱。payMethodList列表的还款金额加起来应该等于实际还款的汇总。

deductAmount

number

平台服务费扣除

必需

主要用于患者在线上三方平台预购的情况。个人欠款该属性传0

memo

string

还款备注

必需

operatorID

integer

操作员Id

必需

操作员员工id

payMethodList

array [object {4}]

还款付款方式

必需

患者还款使用的付款方式。只支持类型为实收的支付方式，还款目前只支持单一还款方式，不支持传入多条。还款方式对应的还款金额应与实际返还一致

contractCorpID

integer

合约机构id

可选

主要用于欠款、应收账款。三方挂账。合约机构id。合约单位、三方平台

payMethod

string

支付方式编号

必需

对应字典支付方式编号

payAmount

number

支付金额

必需

相应支付方式付款金额

setlRefCode

string

结算号码

必需

结算参考码、支付凭证码。支付类别为优惠券时传优惠券编码，支付类别为储值卡时传储值卡卡号、如果是三方平台欠款也可用于存核销码

repayBillList

array [object {4}]

还款单据

必需

需要还款的单据

billLsh

integer

欠款单据流水号

必需

还款需要传入对应的欠款单据流水号

repayAmount

number

还款金额

必需

还款金额=实际还款+平台服务费扣除。“平台服务费扣除”主要针对三方平台欠款。存在患者通过线上三方平台预购项目的情况，患者需在线上预付一部分款项，到院后只需支付余下部分，那患者在线上预付的那部分金额就只能做成三方欠款。当三方平台实际返还患者预付款给医院时会扣除一部分服务费或佣金。

actualRepayAmount

number

实际还款

必需

医院实际收到的钱。对于个人还款“实际还款”等于“还款金额”，对于三方线上平台，则指的是平台剔除服务后实际返还给医院的钱

deductAmount

number

平台服务费扣除

必需

主要用于患者在线上三方平台预购的情况。个人欠款该属性传0

示例

{
    "patientID": 0,
    "repayAmount": 0,
    "actualRepayAmount": 0,
    "deductAmount": 0,
    "memo": "string",
    "operatorID": 0,
    "payMethodList": [
        {
            "contractCorpID": 0,
            "payMethod": "string",
            "payAmount": 0,
            "setlRefCode": "string"
        }
    ],
    "repayBillList": [
        {
            "billLsh": 0,
            "repayAmount": 0,
            "actualRepayAmount": 0,
            "deductAmount": 0
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/anon/openapi/finance/receivables/patient/repay' \
--header 'FRHis-Open-Timestamp: {% mock '\''timestamp'\'' %}' \
--header 'FRHis-Open-App-Id: {{appid}}' \
--header 'FRHis-Open-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "patientID": 0,
    "repayAmount": 0,
    "actualRepayAmount": 0,
    "deductAmount": 0,
    "memo": "string",
    "operatorID": 0,
    "payMethodList": [
        {
            "contractCorpID": 0,
            "payMethod": "string",
            "payAmount": 0,
            "setlRefCode": "string"
        }
    ],
    "repayBillList": [
        {
            "billLsh": 0,
            "repayAmount": 0,
            "actualRepayAmount": 0,
            "deductAmount": 0
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

errcode

integer

状态码

必需

0正常 1失败

errmsg

string

信息

必需

data

object

返回结果

必需

示例

{
    "errcode": 0,
    "errmsg": "string",
    "data": {}
}