API docs by Redocly

ジョブカン会計API (1.0.1)

Download OpenAPI specification:Download

概要

ジョブカン会計APIは、会計データの取得および帳票のダウンロード機能を提供するRESTful APIです。
本ドキュメントはOpenAPI 3.0に沿って記述されています。

認証

Bearer Token認証を採用しています。
各リクエストのAuthorizationヘッダーに Bearer {token} を設定してください。

バージョニングポリシー

このAPIは セマンティックバージョニング に従います：

  • MAJOR: 互換性のない破壊的変更
  • MINOR: 後方互換性のある機能追加
  • PATCH: 後方互換性のあるバグ修正

データ形式

  • 日付は YYYY-MM-DD 形式で入力してください
  • 日時は YYYY-MM-DD HH:MM:SS 形式で出力されます
  • レスポンスはすべて JSON 形式です

エンドポイント概要

基本データ取得

  • GET /account/v1/datas - 利用可能な会計データ一覧を取得
  • GET /account/v1/years - 対象年度の一覧を取得

仕訳データダウンロード

  1. GET /account/v1/journal_dl - ダウンロード予約を作成
  2. GET /account/v1/journal_dl/reports/{id}/status - 処理進捗を確認
  3. GET /account/v1/journal_dl/reports/{id}/download - CSV形式でダウンロード

試算表ダウンロード

  1. GET /account/v1/report_dl - ダウンロード予約を作成
  2. GET /account/v1/report_dl/reports/{id}/status - 処理進捗を確認
  3. GET /account/v1/report_dl/reports/{id}/download - CSV形式でダウンロード

エラーレスポンス

エラー時は以下の形式でレスポンスされます：

{
  "status_code": code,
  "message": message
}

更新情報

最終更新: 2025年07月28日 17:39

データ一覧

会計データ一覧の取得

Authorizations:
Bearer
header Parameters
Jbc-Api-Client-Id
required
string

会社ID

Responses

Response samples

Content type
application/json, utf-8
{
  • "datas": [
    ]
}

年度一覧

年度データ一覧の取得

Authorizations:
Bearer
header Parameters
X-Api-Company-Key
required
string

API会社キー

Responses

Response samples

Content type
application/json, utf-8
{
  • "account_periods": [
    ]
}

仕訳ダウンロード

ダウンロードの予約

ダウンロードの予約

Authorizations:
Bearer
query Parameters
start_date
string

取引日付の範囲 YYYY-MM-DD (省略時：期首日)

end_date
string

取引日付の範囲 YYYY-MM-DD (省略時：期末日)

file_type
integer
Value: 1
Example: file_type=1

1:CSV形式(UTF-8 BOMなし)

csv_type
integer
Enum: 1 2 3
Example: csv_type=1

1:日記帳形式
2:インポート形式(ジョブカン形式)
3:インポート形式(弥生形式)

csv_version
integer
Enum: 2 3 10
Example: csv_version=10

※csv_typeで「2:インポート形式(ジョブカン形式)」を選択した場合に有効
2:旧形式
3:インボイス対応(取引先対応)
10:プロジェクト対応形式 (契約プランによってはプロジェクト関連は無視される)

header Parameters
X-Api-Data-Key
required
string

APIデータキー

Responses

Response samples

Content type
application/json, utf-8
{
  • "download_reserve": {
    }
}

予約の進捗を取得

ダウンロードの予約

Authorizations:
Bearer
path Parameters
id
required
integer

予約ID

header Parameters
X-Api-Data-Key
required
string

APIデータキー

Responses

Response samples

Content type
application/json, utf-8
{
  • "download_reserve": {
    }
}

仕訳ダウンロード

ダウンロードの予約

Authorizations:
Bearer
path Parameters
id
required
integer

予約ID

header Parameters
X-Api-Data-Key
required
string

APIデータキー

Responses

Response samples

Content type
application/json, utf-8
{
  • "status_code": 400,
  • "message": "string"
}

試算表ダウンロード

ダウンロードの予約

ダウンロードの予約

Authorizations:
Bearer
query Parameters
start_month_index
integer [ 0 .. 12 ]

集計の開始月を指定するインデックス
0～11：各月 12：決算仕訳

end_month_index
integer [ 0 .. 12 ]

集計の終了月を指定するインデックス
0～11：各月 12：決算仕訳

report_type
integer
Value: 1
Example: report_type=1

1:試算表（月次・期間）

file_type
integer
Value: 1
Example: file_type=1

1:CSV形式(UTF-8 BOMなし)

header Parameters
X-Api-Data-Key
required
string

APIデータキー

Responses

Response samples

Content type
application/json, utf-8
{
  • "download_reserve": {
    }
}

予約の進捗を取得

ダウンロードの予約

Authorizations:
Bearer
path Parameters
id
required
integer

予約ID

header Parameters
X-Api-Data-Key
required
string

APIデータキー

Responses

Response samples

Content type
application/json, utf-8
{
  • "download_reserve": {
    }
}

試算表ダウンロード

ダウンロードの予約

Authorizations:
Bearer
path Parameters
id
required
integer

予約ID

header Parameters
X-Api-Data-Key
required
string

APIデータキー

Responses

Response samples

Content type
application/json, utf-8
{
  • "status_code": 400,
  • "message": "string"
}