门诊退费

设计中

POST

/api/anon/openapi/his/outpt/refund

最后修改时间：2024-07-13 11:45:37

责任人：肖工

患者结算时会使用多种支付方式（付款方式）组合结算，如：预交金账户支付，现金支付，微信支付，支付宝支付，银行卡支付，代金券支付，积分抵扣支付，欠款等等，我们把现金支付，微信支付，支付宝支付，银行卡支付等统称之为实收或付现。

退费时系统依据医院利益优先原则，能不退款则不退款，基于本次退费总额，按患者原先的付款方式，优先退非实收的部分，非实收的部分大于本次退费总额，就不需要给患者退款，否则才需要给患者退款（非实收的部分退费遵从：从哪来回哪去。比如：预交金支付自动退回到预交金账户，积分返回积分账户，代金券原路返回，欠款就冲抵）。shouldRefund属性对应本次应退款（退现金额），refundMethod属性传入具体的退款方式，是退现金、退微信，退支付宝还是退银行卡。因此如果本次不需要给患者退款，shouldRefund传0，refundMethod列表为空。

请求参数

Header 参数

FRHis-Open-Timestamp

string

必需

默认值:

{% mock 'timestamp' %}

FRHis-Open-App-Id

string

必需

默认值:

FRHis-Open-Token

string

必需

默认值:

FRHis-Open-RequestID

string

可选

Body 参数application/json

patientID

integer

患者Id

必需

settleRecID

integer

门诊结账记录流水号

必需

refundAmount

number

退费金额

必需

本次明细退费总额。需要等于明细退费金额之和

shouldRefund

number

应退款金额

必需

可退实收、可退现部分。是对refundMethod列表中退款金额的汇总。由于结算时可能存在多支付方式，如：现金支付，其他实收类支付，预交金支付，代金券支付，积分抵扣支付，欠款等等。退款时系统遵从医院利益最大化，患者要退费，系统根据患者原先的支付方式，先退非实收的部分，非实收部分大于本次退费总额，就不需要给患者退款，否则才给患者退款。因此仅当需要给患者退款时，才需要传入refundMethod列表属性

refundMethod

object (支付方式、付款方式BO)

退款方式

必需

可退实收的部分。由于结算时存在多支付方式，如：现金支付，其他实收类支付，预交金支付，代金券支付，欠款等等。退款时系统遵从医院利益最大化，优先退非实收部分，非实收部分退完，最后才退实收部分。因此仅当非实收部分退完，才允许退款，才需要传入退款方式

contractCorpID

integer

合约机构id

可选

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

payMethod

string

支付方式编号

必需

对应字典支付方式编号

payAmount

number

支付金额

必需

相应支付方式付款金额

setlRefCode

string

结算号码

必需

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

refundDetails

array [object {5}]

退费明细

必需

实际需要退费的明细。不需要退费的明细不需要传入

lsh

integer

费用明细流水号

必需

对应门诊费用明细记录查询返回的illSerialNumber属性

itemType

integer

项目类型

必需

1、药品，2、收费项目，3、材料

tfsl

number

退费数量

必需

tfje

number

退费金额

必需

tfzy

string

退费摘要

必需

明细退费摘要

memo

string

退款备注

必需

示例

{
    "patientID": 0,
    "settleRecID": 0,
    "refundAmount": 0,
    "shouldRefund": 0,
    "refundMethod": {
        "contractCorpID": 0,
        "payMethod": "string",
        "payAmount": 0,
        "setlRefCode": "string"
    },
    "refundDetails": [
        {
            "lsh": 0,
            "itemType": 0,
            "tfsl": 0,
            "tfje": 0,
            "tfzy": "string"
        }
    ],
    "memo": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/anon/openapi/his/outpt/refund' \
--header 'FRHis-Open-Timestamp;' \
--header 'FRHis-Open-App-Id;' \
--header 'FRHis-Open-Token;' \
--header 'FRHis-Open-RequestID;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "patientID": 0,
    "settleRecID": 0,
    "refundAmount": 0,
    "shouldRefund": 0,
    "refundMethod": {
        "contractCorpID": 0,
        "payMethod": "string",
        "payAmount": 0,
        "setlRefCode": "string"
    },
    "refundDetails": [
        {
            "lsh": 0,
            "itemType": 0,
            "tfsl": 0,
            "tfje": 0,
            "tfzy": "string"
        }
    ],
    "memo": "string"
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

修改于 2024-07-13 11:45:37

门诊收银结算

分诊登记接口