API連携オプション 仕訳データ自動連携の初期設定

概要

  • 「API連携オプション」(有料)のお申込が必要です。
  • APIを通じて、「楽楽請求」の「計上仕訳データ」「支払仕訳データ」の作成、および取得、作成状況の確認ができます。
    ※API連携を行うための連携プログラム(システム構築)は「楽楽請求」外に貴社側でご用意いただく必要があります。
    (サンプルプログラムはご提供可能です。)
  • HTTPヘッダに「楽楽請求」が発行するAPIトークンを埋め込むことで認証を実現します。

「楽楽請求」できること

APIトークンの管理

  • APIトークンの発行

  • APIのアクセス制限(アクセスを許可するIPアドレスの登録)

注意

  • API連携で取得できるファイルは、API実行時点で「データ出力」タブ>「計上仕訳データの作成」または「支払仕訳データの作成」画面で、「未作成」の確定済み請求書が全て対象となります。
    条件での絞込はできません。

  • 過去に出力したファイルを取得するAPIは提供しておりません。
    ※過去にさかのぼって出力ファイルを取得したい場合は
    「データ出力」タブ>「計上仕訳データ出力」「支払仕訳データ出力」の画面上から手動で取得してください。

  • API呼出しには以下の制限が設定されています。また、これらの設定値は変更される場合があります。
    • リクエスト数:1アカウント毎に1分間に20リクエスト以下(ユーザー毎ではない)

  • メンテナンス時間中のAPIリクエストに対してはHTTPステータス503で返却されます。
    詳細はAPI連携 「楽楽請求」サービス停止中の場合、自動連携はどのような挙動になるのか知りたいをご確認ください。

補足

 「楽楽請求」の画面から作成したファイル同様にAPI経由で作成された仕訳ファイルも、作成完了日時の翌月末に自動削除されます。

APIトークン

APIトークンとは

「楽楽請求」のAPIの利用時に認証用キーとして使用する文字列です。
APIトークンは、「楽楽請求」の管理者権限のみ発行できます。

APIトークンの発行

「設定」タブ>「システム設定」>「API連携設定」画面にて「生成」をクリックすることで「APIトークン」が発行されます。
※「システム設定」の操作には管理者権限が必要です。
6010_seihin_01_20260325APIトークンは生成直後のみ表示されます。
もし紛失した場合は再生成を実施ください。

APIトークンの再生成

「再生成」ボタンをクリック後に表示される「APIトークンの再生成」画面で「再生成」をクリックすることで、APIトークンが再生成されます。
6010_seihin_02_20260325※上記記載の通り再生成した場合、APIトークンは上書きされ過去生成されていたAPIトークンは利用できなくなります。

APIトークンの削除

「削除」ボタンをクリック後に表示される「APIトークンの削除」画面で「削除」をクリックすることで、APIトークンが削除され、APIが使用できない状態になります。
6010_seihin_03_20260325

APIのアクセス制限

API専用の接続を許可するIPアドレスを制限することが可能です。

設定手順

  1. 「設定」タブ>「システム設定」>「セキュリティ設定」をクリック
    ※「システム設定」の操作には管理者権限が必要です。
  2. 「APIのアクセス制限」項目を「制限する」を選択
  3. 許可するIPアドレスを入力
  4. 「保存」をクリック
    6010_seihin_04_20260325
《完了》

リクエスト方法

APIへのリクエストを行う際の基本的な情報は以下の通りです。

計上仕訳データ作成API

  • 通信方式:HTTPS

  • メソッド:POST

  • 文字コード:UTF-8

  • URL:https://【ドメイン】/【テナント】/api/v1/invoice_journals/output
    詳細については、別途記載されている「URL例」をご参照ください。
  • ヘッダ:X-SK-apitoken:{APIトークン}
    ※上記のAPIトークンを含むリクエストヘッダを必ず指定してください。
    ※APIトークンは、別途記載されている「APIトークンの発行」をご確認ください。

■URL例
https://app.rakurakuseikyu.jp/xxxxxx/api/v1/invoice_journals/output

◆app.rakurakuseikyu.jp →利用するドメイン
◆xxxxxxx        →利用するテナント
◆api/v1           →APIバージョンの指定
◆invoice_journals/output→API名

リクエスト

  • ヘッダ

    ヘッダ

    必須

    X-SK-apitoken

    {APIトークン}

    Content-Type

    application/json

     

  • ボディ

パラメータ名

項目名

必須

内容

isItemNameOutputted

項目名を出力するかどうかのフラグ

真偽値

true:出力する

false:出力しない

(例)
curl -i -X 'POST' \ 
  'https://【ドメイン】/【テナント】api/v1/invoice_journals/output' \
  -H 'X-SK-apitoken: {APIトークン}'\
  -H 'Content-Type: application/json' \
  -d '{ 
        "isItemNameOutputted": true 
    }'

レスポンス

  • ボディ

パラメータ名

項目名

必須

内容

invoiceJournalOutputId

計上仕訳データ出力ID

整数

データ出力状況の確認に使用するID

(例)
HTTP/1.1 200 
....

{
    "invoiceJournalOutputId": 1
}

補足

  • API連携で取得できるファイルは、API実行時点で「データ出力」タブ>「計上仕訳データ作成」画面で「未作成」の確定済み請求書が全て対象となります。
    条件での絞込はできません。
  • API連携で「計上仕訳データの作成」を実施した場合
    「楽楽請求」の「データ出力」>「計上仕訳データの出力」画面の「社員名」は「ー」で表示されます。

 

計上仕訳データ作成状況確認API

  • 通信方式:HTTPS

  • メソッド:GET

  • 文字コード:UTF-8

  • URL:https://【ドメイン】/【テナント】/api/v1/invoice_journals/output/【invoiceJournalOutputId】

リクエスト

  • ヘッダ

ヘッダ

必須

X-SK-apitoken

{APIトークン}

  • パスパラメータ

パラメータ名

項目名

必須

内容

invoiceJournalOutputId

計上仕訳データ出力ID

整数

仕訳データ作成APIで取得したID

(例)
curl -i -X 'GET' \
  https://【ドメイン】/【テナント】api/v1/masters/import/1 \
  -H 'X-SK-apitoken: {APIトークン}'\

レスポンス

  • ボディ

パラメータ名

項目名

必須

内容

備考

status

計上仕訳データ出力ステータス

整数

1:作成準備中

2:作成中

3:完了

4:作成失敗

5:作成取消

 

finishedAt

作成完了日時

文字列

 

YYYY-MM-DDTHH:MM:SS

status= 3or4or5の場合は必須

employee

社員

オブジェクト

 

作成した社員情報

 

code

社員コード

文字列

-

 

name

社員名

文字列

-

 

isDeleted

削除フラグ

真偽値

true:削除済みの社員

false:未削除の社員

 

outputFileSummaries

計上仕訳データ出力ファイルのリスト

配列

-

 

journalOutputSettingName

計上仕訳データ出力ファイル名

文字列

-

 

expiredAt

作成結果の保存期限

文字列

YYYY-MM-DDTHH:MM:SS

 

isDownloaded

ダウンロード済みフラグ

真偽値

true:
ダウンロード済み

false:
未ダウンロード

 

(例)
HTTP/1.1 200 
....

{
    "status": 3,
    "finishedAt": "2026-01-22T12:30:50",
    "employee": {
        "code": "code1"
        "name": "営業太郎"
        "isDeleted": true
    },
    "outputFileSummaries": [
        {
            "journalOutputSettingName": "計上仕訳出力設定A",
            "expiredAt": "2026-02-28T23:59:59",
            "isDownloaded": false
        },
    ]
  }

補足

  • ステータスは「作成準備中」「作成中」「完了」「作成失敗」「作成取消」です。
  • 作成終了日時:ステータスが「完了」「作成失敗」「作成取消」の時のみ返却します。
  • 各ファイルが作成されたかおよびダウンロードされたかはステータスが「完了」の時のみ返却します。

 

計上仕訳データダウンロードAPI

  • 通信方式:HTTPS

  • メソッド:GET

  • 文字コード:UTF-8

  • URL:https://【ドメイン】/【テナント】/api/v1/invoice_journals/output/【invoiceJournalOutputId】/download

リクエスト

  • ヘッダ

ヘッダ

必須

X-SK-apitoken

{APIトークン}

Content-Type

application/json

  • パスパラメータ

パラメータ名

項目名

必須

内容

invoiceJournalOutputId

計上仕訳データ出力ID

整数

仕訳データ作成APIで取得したID

  • ボディ

パラメータ名

項目名

必須

内容

journalOutputSettingName

仕訳出力名

文字列

計上仕訳出力設定の仕訳出力名

(例)
curl -i -X 'POST' \ 
  https://【ドメイン】/【テナント】api/v1/payment_journals/output/1/download \
  -H 'X-SK-apitoken: {APIトークン}'\
  -H 'Content-Type: application/json' \
  -d '{ 
         "journalOutputSettingName": "計上仕訳出力設定A"
    }'

レスポンス

  • ボディ

パラメータ名

項目名

必須

内容

備考

(出力データ)

計上仕訳出力データファイル

文字列

指定した支払仕訳出力データファイル

出力ファイルが作成されなかった

もしくはダウンロード期限を過ぎていたら404エラーになる

(例)
HTTP/1.1 200 
....


"識別フラグ","伝票No.","決算"
"2111","000000","","20260123"


支払仕訳データ作成API

  • 通信方式:HTTPS

  • メソッド:POST

  • 文字コード:UTF-8

  • URL:https://【ドメイン】/【テナント】/api/v1/invoice_journals/output
    ※詳細については、別途記載されている「URL例」をご参照ください。

  • :X-SK-apitoken: {APIトークン}
    ※上記のAPIトークンを含むリクエストヘッダを必ず指定してください。       ※APIトークンは、別途記載されている「APIトークンの発行」をご確認ください。

■URL例
https://app.rakurakuseikyu.jp/xxxxxx/api/v1/invoice_journals/output

◆app.rakurakuseikyu.jp    → 利用するドメイン
◆xxxxxxx         → 利用するテナント
◆api/v1            → APIバージョンの指定
◆invoice_journals/output → API名

リクエスト

  • ヘッダ

    ヘッダ

    必須

    X-SK-apitoken

    { APIトークン }

    Content-Type

    application/json

     

 
  • ボディ

パラメータ名

項目名

必須

内容

備考

postingDateAdoptType

支払仕訳の仕訳日設定区分

整数

1: 振込日を使用する

2: 個別に設定する

 

postingDate

仕訳日

文字列

 

YYYY-MM-DD

postingDateAdoptType = 2の場合に必須

isItemNameOutputted

項目名を出力するかどうかのフラグ

真偽値

true:出力する

false:出力しない

 

(例)
curl -i -X 'POST' \ 
  'https://【ドメイン】/【テナント】api/v1/payment_journals/output' \
  -H 'X-SK-apitoken: {APIトークン}'\
  -H 'Content-Type: application/json' \
  -d '{ 
    "postingDateAdoptType": 2,
    "postingDate": "2026-01-22",
    "isItemNameOutputted": false
    }'

レスポンス

  • ボディ

パラメータ名

項目名

必須

内容

paymentJournalOutputId

支払仕訳データ出力ID

整数

データ出力状況の確認に使用するID

(例)
HTTP/1.1 200 
....
{
    "paymentJournalOutputId": 1
}

補足

  • API連携で取得できるファイルは、API実行時点で「データ出力」タブ>「支払仕訳データ作成」画面で「未作成」の確定済み請求書が全て対象となります。
    条件での絞込はできません。
  • API連携で「支払仕訳データの作成」を実施した場合
    「楽楽請求」の「データ出力」>「支払仕訳データの出力」画面の「社員名」は「ー」で表示されます。

 

支払仕訳データ作成状況確認API

  • 通信方式:HTTPS

  • メソッド:GET

  • 文字コード:UTF-8

  • URL:https://【ドメイン】/【テナント】/api/v1/payment_journals/output/【paymentJournalOutputId】

リクエスト

  • ヘッダ

ヘッダ

必須

X-SK-apitoken

{ APIトークン }

Content-Type

application/json

  • パスパラメータ

パラメータ名

項目名

必須

内容

paymentJournalOutputId

支払仕訳データ出力ID

整数

仕訳データ作成APIで取得したID

(例)
curl -i -X 'GET' \
   https://【ドメイン】/【テナント】api/v1/payment_journals/output/1

レスポンス

  • ボディ

パラメータ名

項目名

必須

内容

備考

status

支払仕訳データ出力ステータス

整数

1: 作成準備中

2: 作成中

3: 完了

4: 作成失敗

5: 作成取消

 

finishedAt

作成完了日時

文字列

 

YYYY-MM-DDTHH:MM:SS

status = 3 or 4 or 5の場合は必須

employee

社員

オブジェクト

 

作成した社員情報

 

code

社員コード

文字列

-

 

name

社員名

文字列

-

 

isDeleted

削除フラグ

真偽値

true:削除済みの社員

false:未削除の社員

 

outputFileSummaries

支払仕訳データ出力ファイルのリスト

配列

-

 

journalOutputSettingName

支払仕訳データ出力ファイル名

文字列

-

 

expiredAt

作成結果の保存期限

文字列

YYYY-MM-DDTHH:MM:SS

 

isDownloaded

ダウンロード済みフラグ

真偽値

true:ダウンロード済み

false:未ダウンロード

 

(例)
HTTP/1.1 200 
....

{
    "status": 3,
    "finishedAt": "2026-01-22T12:30:50",
    "employee": {
        "code": "code1"
        "name": "営業太郎"
        "isDeleted": true
    },
    "outputFileSummaries": [
        {
            "journalOutputSettingName": "支払仕訳出力設定A",
            "expiredAt": "2026-02-28T23:59:59",
            "isDownloaded": false
        },
    ]
  }

補足

  • ステータスは「作成準備中」「作成中」「完了」「作成失敗」「作成取消」です。
  • 作成終了日時:ステータスが「完了」「作成失敗」「作成取消」の時のみ返却します。
  • 各ファイルが作成されたかおよびダウンロードされたかはステータスが「完了」の時のみ返却します。

 

支払仕訳データダウンロードAPI

  • 通信方式:HTTPS

  • メソッド:POST

  • 文字コード:UTF-8

  • URL:https://【ドメイン】/【テナント】/api/v1/payment_journals/output/【paymentJournalOutputId】/download

リクエスト

  • ヘッダ

ヘッダ

必須

X-SK-apitoken

{ APIトークン }

Content-Type

application/json

  • パスパラメータ

パラメータ名

項目名

必須

内容

paymentJournalOutputId

支払仕訳データ出力ID

整数

仕訳データ作成APIで取得したID

  • ボディ

パラメータ名

項目名

必須

内容

journalOutputSettingName

仕訳出力名

文字列

支払仕訳出力設定の仕訳出力名

(例)
curl -i -X 'POST' \ 
  https://【ドメイン】/【テナント】api/v1/payment_journals/output/1/download \
  -H 'X-SK-apitoken: {APIトークン}'\
  -H 'Content-Type: application/json' \
  -d '{ 
         "journalOutputSettingName": "支払仕訳出力設定A"
    }'

レスポンス

  • ボディ

パラメータ名

項目名

必須

内容

備考

(出力データ)

支払仕訳出力データファイル

文字列

指定した支払仕訳出力データファイル

出力ファイルが作成されなかった

もしくはダウンロード期限を過ぎていたら404エラーになる

(例)
HTTP/1.1 200 
....


"識別フラグ","伝票No.","決算"
"2111","000000","","20260123"

ステータスコード

レスポンスのボディ部に書かれたステータスコードから、
リクエスト成功・失敗を判別することが可能です。
HTTPのステータスコードも同様の値を返却します。

コード 状態 詳細 ボディ(例) 備考
200 成功 - {
"masterImportJobId": 1
}
 
400 通常エラー 入力エラーなど、アプリケーションが検出するエラー {
"errors": [
{
"name": "fieldName",
"msg": "エラーメッセージ"
}
]
}
 
401 認証エラー 認証失敗、必要な権限がない場合のエラー    
403 オプション未契約・IPアドレス制限エラー API機能が利用できない場合のエラー {"code":"FORBIDDEN_ACC
ESS"}
FORBIDDEN_
ACCESS: オプション未契約

FORBIDDEN_
POLICY: IPアドレス制限エラー
404 対象URLなし URLの指定が間違っている場合のエラー    
405 対応していないメソッド 対応していないHTTPメソッドでリクエストされた場合のエラー    
406 対応していないヘッダ Acceptヘッダの値がレスポンス形式と一致しない場合のエラー    
415 対応していないファイルタイプ 対応していないファイルタイプでリクエストされた場合のエラー    
409 リソースの競合 複数のユーザーが同時に操作した場合のエラー    
429 リクエスト回数超過 最大アクセス数を超える回数のリクエストが送信された場合のエラー    
500 内部エラー 予期しないエラー
※問い合わせ
   
503 メンテナンス中 「楽楽請求」のメンテナンス中に返すエラー    

 

レスポンス

  • ヘッダ

ヘッダ

Content-Type

application/json

JSON以外の場合は、ファイル形式に準じた値

X-Content-Type-Options

nosniff

Cache-Control

private, no-store, no-cache, must-revalidate

Pragma

no-cache

X-XSS-Protection

1; mode=block

X-Frame-Options

deny

Strict-Transport-Security

max-age=31536000; includeSubDomains

Content-Security-Policy

default-src 'none'

X-Content-Security-Policy

default-src 'none'

X-WebKit-CSP

default-src 'none'

content-disposition

ファイルに準じた値

inline; filename*=UTF-8''〇〇.csv

connection

keep-alive

content-length

ex) 100

Date

ex) Thu, 22 Jan 2026 06:32:53 GMT

content-encoding

gzip

vary

accept-encoding

transfer-encoding

chunked

サービスメンテナンス時の注意点

サービス停止ありのメンテナンス中はAPI実行をすることはできません。
メンテナンス終了後に実行をお願いいたします。
なお、メンテナンス時間はサービス稼働状況に掲載しております。
サービス停止なしのメンテナンス中はAPIの実行が可能です。

サンプルプログラム

サンプルプログラムに関しては、サンプルソースを別途用意しております。
ご希望のお客様は以下フォームよりお問い合わせください。

注意

なおあくまでサンプルであり、この通りに作ることを推奨しているものではなく、動作の保証はしておりません。
プログラムの内容について具体的なご案内はできないため、予めご了承ください。

(記事ID:6010)

「楽楽請求」カスタマーサクセス担当
「楽楽請求」カスタマーサクセス担当
「楽楽請求」のカスタマーサクセス担当です。
請求書処理の業務効率化に役立つ情報を発信してまいります!