ページを印刷|
対象プラン
|
法人プラン | ✓ ライト | ✓ ビジネス | ✓ エンタープライズ | |||||
| 個人プラン | ✓ スターター | ✓ スタンダード | ✓ プレミアム |
【注意】本ページはソフトウェア開発者向けのページです
freee APIは、freeeの機能を外部のプログラムから利用するためのインターフェースです。このAPIを利用して、レセコンのデータを送信する場合の仕様の留意点を紹介します。
最新のAPI仕様はこちらで公開しています。（検証用のfreeeアカウントについてはこちら）
freee API
目次
レセコン連携の要件と留意点
レセコン（レセプトコンピュータ）の情報を連携する場合、基本的な留意点はレジの売上情報の連携と同様です。次のURLをご参照ください。
※ レジ連携とは異なる点もありますのでご注意ください。
勘定科目についてのポイント
売上としてデータの送信ができれば必要最低限な連携を行えますが、会計システムとして正確な記帳を行うためには自由診療収入、保険診療収入といった収入区分ごとに勘定科目を設定し、個別の税区分を設定する必要があります。
自由診療収入、保険診療収入といった新たな勘定科目の作成はfreee API(POST /api/1/account_items.json)から行えます。
レセコン連携時の勘定科目・品目の使用例
| 勘定科目 | 品目 | 内容 | 税区分 |
|---|---|---|---|
|
自由診療収入 |
自由診療 | 保険適用外の診療分の売上 | 課税売上X% |
| 物販 | 保険適用外の物販での売上 | 課税売上X% | |
| 保険窓口収入 | 社保窓口収入 | 保険診療による窓口収入。内容別 | 非課売上 |
| 国保窓口収入 | |||
| 後期高齢者窓口収入 | |||
| 保険診療収入 | 社保保険診療収入 | 保険診療の審査支払機関請求分の売上。請求先別 | |
| 国保保険診療収入 |
※ 病院・クリニックにおける科目テンプレートはこちら
※ 上表では内容によって品目を使い分ける形としていますが、勘定科目で分けても差し支えありません。
審査支払機関に関する処理
医業特有の保険診療報酬の処理についてのポイントです。
請求する売上の処理
審査支払機関に請求する売上はクレジット取引と同様に2通りの処理ができます。
- 保険診療報酬分の「売上高」のdealについてpaymentsを指定せず、未決済の取引として登録
- 保険診療報酬分の「売上高」のdealについてpaymentsで売掛金扱いの口座を選択し、当該口座で決済を登録
口座振替によって入金時の消込を一括で行える点や審査によって生じる修正を効率的に処理できる点で、一度売掛金扱いの口座で登録し、入金があった際に当該口座と消し込むことが望ましいです。
取引登録のタイミングは月に１回審査支払機関に請求する際の処理が一般的ですが、売掛金扱いの口座によって債権管理が行えている場合は日次で処理できます。
返戻と減点の処理
返戻が発生した時点で返戻分を請求時に登録した取引から減少させる必要があります。また、減点によって生じた請求額との差額は「保険等査定減」勘定で処理することが望ましいです。
- 未決済の取引として登録している場合、freee側で手動の操作が必要となります（手動での修正・登録するか、削除後に再度連携を実行する）。
- 売掛金扱いの口座で登録している場合、当該口座から減少させる取引を送信することで処理できます。
よって、「請求時に売掛金扱いの口座を選択し決済を登録。返戻と減点が発生した際は当該口座から減少させる取引を送信する」形式が望ましいと考えられます。
レセコンの売上情報の送信例
【前提】
〇〇医院は2017年03月10日の売上情報を業務終了後にfreeeに送信した。また、審査支払機関に2月分の保険収入の請求も行った。当日、売上は自由診療と保険診療（国保、社保）があった。〇〇医院では、収入区分ごとに勘定科目を設定してある。
[支払手段の内訳] 現金 760,000円、カード 140,000円
[2月分請求の内訳] 国保診療収入 420,000円、社保診療収入 130,000円
※カードは口座を用いて決済を登録する場合
リクエスト
curl -i -X POST \
-H "Authorization:Bearer #############################################" \
-H "Content-Type:application/json" \
-d \
{
"company_id" : ZZZZZZ,
"issue_date" : "2017-03-10",
"type" : "income",
"details" : [
{
"account_item_id" : AAAAAA,
"tax_code" : 21,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 500000,
"description" : ""
},
{
"account_item_id" : BBBBBB,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 200000,
"description" : ""
},
{
"account_item_id" : CCCCCC,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 200000,
"description" : ""
}
],
"payments" : [
{
"date" : "2017-03-10",
"from_walletable_type" : "wallet",
"from_walletable_id" : GGGGGG,
"amount" : 760000
},
{
"date" : "2017-03-10",
"from_walletable_type" : "wallet",
"from_walletable_id" : HHHHHH,
"amount" : 140000
}
]
}' \
'https://api.freee.co.jp/api/1/deals'curl -i -X POST \
-H "Authorization:Bearer #############################################" \
-H "Content-Type:application/json" \
-d \
{
"company_id" : ZZZZZZ,
"issue_date" : "2017-02-28",
"type" : "income",
"details" : [
{
"account_item_id" : DDDDDD,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 420000,
"description" : ""
},
{
"account_item_id" : EEEEEE,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 130000,
"description" : ""
}
],
"payments" : [
{
"date" : "2017-02-28",
"from_walletable_type" : "wallet",
"from_walletable_id" : IIIIII,
"amount" : 420000
},
{
"date" : "2017-02-28",
"from_walletable_type" : "wallet",
"from_walletable_id" : JJJJJJ,
"amount" : 130000
}
]
}' \
'https://api.freee.co.jp/api/1/deals'
その後、
2017年03月25日、〇〇医院では10日に請求したレセプトのうち国保診療収入10,000円分の返戻があった。レセプト修正を行い翌26日に国保診療収入9,000円分再請求した。
リクエスト
curl -i -X POST \
-H "Authorization:Bearer #############################################" \
-H "Content-Type:application/json" \
-d \
{
"company_id" : ZZZZZZ,
"issue_date" : "2017-03-25",
"type" : "expense",
"details" : [
{
"account_item_id" : DDDDDD,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 10000,
"description" : ""
}
],
"payments" : [
{
"date" : "2017-03-25",
"from_walletable_type" : "wallet",
"from_walletable_id" : IIIIII,
"amount" : 10000
}
]
}' \
'https://api.freee.co.jp/api/1/deals'curl -i -X POST \
-H "Authorization:Bearer #############################################" \
-H "Content-Type:application/json" \
-d \
{
"company_id" : ZZZZZZ,
"issue_date" : "2017-03-26",
"type" : "income",
"details" : [
{
"account_item_id" : DDDDDD,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 9000,
"description" : ""
}
],
"payments" : [
{
"date" : "2017-03-26",
"from_walletable_type" : "wallet",
"from_walletable_id" : IIIIII,
"amount" : 9000
}
]
}' \
'https://api.freee.co.jp/api/1/deals'
リクエスト
curl -i -X POST \
-H "Authorization:Bearer #############################################" \
-H "Content-Type:application/json" \
-d \
{
"company_id" : ZZZZZZ,
"issue_date" : "2017-04-05",
"type" : "expense",
"details" : [
{
"account_item_id" : FFFFFF,
"tax_code" : 23,
"item_id" : ,
"section_id" : ,
"tag_ids" : ,
"amount" : 20000,
"description" : ""
}
],
"payments" : [
{
"date" : "2017-03-25",
"from_walletable_type" : "wallet",
"from_walletable_id" : JJJJJJ,
"amount" : 20000
}
]
}' \
'https://api.freee.co.jp/api/1/deals'Paramsの前提について：
| Param Name | 内容 | 値 |
|---|---|---|
| company_id | 〇〇医院の事業所ID | ZZZZZZ |
| account_item_id | 「自由診療収入」の勘定科目ID | AAAAAA |
| account_item_id | 「国保窓口収入」の勘定科目ID | BBBBBB |
| account_item_id | 「社保窓口収入」の勘定科目ID | CCCCCC |
| account_item_id | 「国保診療収入」の勘定科目ID | DDDDDD |
| account_item_id | 「社保診療収入」の勘定科目ID | EEEEEE |
| account_item_id | 「保険等査定減」の勘定科目ID | FFFFFF |
| tax_code | 「課税売上」の税区分コード | 21 |
| tax_code | 「非課売上」の税区分コード | 23 |
| from_walletable_id | 診療所１の現金の口座ID | GGGGGG |
| from_walletable_id | 診療所１のカード売掛金の口座ID | HHHHHH |
| from_walletable_id | 診療所１の国保診療収入売掛金の口座ID | IIIIII |
| from_walletable_id | 診療所１の社保診療収入売掛金の口座ID | JJJJJJ |
※ 売掛金口座のtype(from_walletable_type)は、銀行口座でもクレジットカードでもないためwalletとなります。
※各種IDは事業所毎に異なります(税区分コードのみ共通となっています）