負担割合情報登録API

利用者の負担割合情報を登録するAPI

API ID

I0006

Request URL

co-pay/add
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/co-pay/add
環境 URL
本番環境 https://api.link.carekarte.jp/co-pay/add

HTTPメソッド

POST

リクエスト

ヘッダー

名前 必須 値
Content-Type ○ application/json
authorization ○ tokenサービスで取得した値を設定

ボディ

パラメータ名 物理パラメータ名 型 必須 文字桁数 文字種/形式 仕様
利用者ID userId String 〇 10桁   U0007　事業所所属利用者一覧取得API等から取得してください。
負担割合交付日 issueDate String     YYYY-MM-DD  
被保険者番号 insuredNumber String   10桁    
保険者番号 isurerNumber String 〇 6桁    
負担割合期間開始日 sdate String 〇   YYYY-MM-DD  
負担割合期間終了日 edate String 〇   YYYY-MM-DD 負担割合期間開始日以降である必要があります
負担割合 rate String 〇   半角数字 国の負担する割合を％で入力します 個人負担が1割なら90、2割なら80、3割なら70を入力します
職員ID staffId String 〇 10桁   ST0003　事業所所属職員一覧取得API等から取得してください。

サンプルデータ

{ 
    "userId": "0000000002",
    "issueDate": "2022-07-15",
    "insuredNumber": "1111111206",
    "isurerNumber": "221028",
    "sdate": "2022-08-02",
    "edate": "2022-08-31",
    "rate": "80",
    "staffId": "0000000004"
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 型 文字桁数 文字種/形式 仕様
利用者番号 userId String 10桁   リクエストしたuserIdが返却されます
開始日 sdate String   YYYY-MM-DD リクエストしたsdateが返却されます

 

負担割合証の登録に成功した際のサンプルデータ

{
    "userId": "0000000068"
    "sdate": "2022-10-01"
}

エラーレスポンス

エラーレスポンスを参照してください。

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEで負担割合証を確認できる画面です。