API Documentation

API Endpoint

仕訳

仕訳の更新

POST /fx/tc09999001/tfa/api/v2/slips/import
Requests仕訳更新リクエスト例
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Body
{
  "slips": [
    {
      "ymd_tr": "2022-06-01",
      "journo": "1",
      "journo_read": "1",
      "vouno": "1",
      "cd_coopsystem": "EX",
      "cd_fbcat": "01",
      "cd_fbbdcat": "01",
      "is_add_depmaster": 1,
      "is_add_cstmmaster": 1,
      "is_add_auxmaster": 1,
      "detail": [
        {
          "pos_dsp": 1,
          "is_ocr_dc": 1,
          "cd_dep": "",
          "cd_act": "1111",
          "cd_auxact": "",
          "cd_cstm": "000001",
          "nm_cstm": "A商店",
          "tptn": "0",
          "tbptn": "",
          "amnt_tr": 2000,
          "amnt_cmtx": 0,
          "is_reduce_cmtxrate": 0,
          "cmtxrate": 0,
          "is_autocalccmtx": 1,
          "cat_purday": 9,
          "ymd_purday1": "",
          "ymd_purday2": "",
          "rcj_slip": "摘要"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "slips": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ymd_tr": {
            "type": "string",
            "description": "取引年月日(8桁、またはハイフン、スラッシュ区切りで入力可能 ※例: '20210101, 2022-01-01, 2022/01/01')"
          },
          "journo": {
            "type": "string",
            "description": "伝票番号(半角数字のみ minLength: 0, maxLength: 5)"
          },
          "journo_read": {
            "type": "string",
            "description": "当該仕訳と連携元システムの取引とを対応させるための番号(半角数字のみ minLength: 0, maxLength: 6)"
          },
          "vouno": {
            "type": "string",
            "description": "証憑書番号(半角英数字のみ minLength: 0, maxLength: 6)"
          },
          "cd_coopsystem": {
            "type": "string",
            "description": "連携システムコード(Length: 2 API契約締結時に振り出したシステムコード)"
          },
          "cd_fbcat": {
            "type": "string",
            "description": "収支区分(Length: 2 「'01 ~ 12'」のみ)　※資金管理をする取引の場合のみ入力　別表で説明"
          },
          "cd_fbbdcat": {
            "type": "string",
            "description": "内訳区分(Length: 2 「'01 ~ 99'」のみ)　※資金管理をする取引の場合のみ入力　別表で説明"
          },
          "is_add_depmaster": {
            "type": "number",
            "description": "システム側に登録されていない部門コードを送った場合に、自動でマスターに追加するか否か(1: 追加する, 0: 追加しない)"
          },
          "is_add_cstmmaster": {
            "type": "number",
            "description": "システム側に登録されていない取引先コードを送った場合に、自動でマスターに追加するか否か(1: 追加する, 0: 追加しない)"
          },
          "is_add_auxmaster": {
            "type": "number",
            "description": "システム側に登録されていない口座コードを送った場合に、自動でマスターに追加するか否か(1: 追加する, 0: 追加しない)"
          },
          "detail": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "pos_dsp": {
                  "type": "number",
                  "description": "仕訳明細の表示位置（minimum: 1, maximum: 60）"
                },
                "is_ocr_dc": {
                  "type": "number",
                  "description": "借方か貸方か(1:借方, 0:貸方)"
                },
                "cd_dep": {
                  "type": "string",
                  "description": "部門コード(Length: 3)"
                },
                "cd_act": {
                  "type": "string",
                  "description": "勘定科目コード(Length: 4)"
                },
                "cd_auxact": {
                  "type": "string",
                  "description": "口座コード(minLength: 0, maxLength: 2)"
                },
                "cd_cstm": {
                  "type": "string",
                  "description": "取引先コード(Length: 6)"
                },
                "nm_cstm": {
                  "type": "string",
                  "description": "取引先名(minLength: 0, maxLength: 40)　※取引先コードを入力した場合、この値は無視される"
                },
                "tptn": {
                  "type": "string",
                  "description": "課税区分(minLength: 0, maxLength: 2 ※別表で説明)"
                },
                "tbptn": {
                  "type": "string",
                  "description": "事業区分(minLength: 0, maxLength: 2 ※別表で説明)"
                },
                "amnt_tr": {
                  "type": "number",
                  "description": "取引金額(minimum: -99999999999, maximum: 99999999999)"
                },
                "amnt_cmtx": {
                  "type": "number",
                  "description": "消費税金額(minimum: -99999999999, maximum: 99999999999)"
                },
                "is_reduce_cmtxrate": {
                  "type": "number",
                  "description": "軽減税率か否か(1: 軽減税率, 0: 標準税率)"
                },
                "cmtxrate": {
                  "type": "number",
                  "description": "消費税率(minimum: 0, maximum: 9999 ※税率を100倍した値を入力 例: 10%の場合には1000を入力)"
                },
                "is_autocalccmtx": {
                  "type": "number",
                  "description": "消費税額自動計算か否か(1: 自動計算, 0: 自動計算ではない)"
                },
                "cat_purday": {
                  "type": "number",
                  "description": "実際の仕入れ日表示区分(minimum: 0, maximum: 9 ※別表で説明)"
                },
                "ymd_purday1": {
                  "type": "string",
                  "description": "実際の仕入れ日１(※別表で説明)"
                },
                "ymd_purday2": {
                  "type": "string",
                  "description": "実際の仕入れ日２(※別表で説明)"
                },
                "rcj_slip": {
                  "type": "string",
                  "description": "元帳摘要(minLength: 0, maxLength: 80)"
                }
              },
              "required": [
                "pos_dsp",
                "is_ocr_dc",
                "cd_act",
                "amnt_tr"
              ]
            },
            "description": "仕訳の明細部"
          }
        },
        "required": [
          "ymd_tr",
          "cd_coopsystem",
          "detail"
        ]
      },
      "description": "仕訳"
    }
  },
  "required": [
    "slips"
  ]
}
Responses201400401403406
Headers
Content-Type: application/json
Body
{
  "status": 201,
  "informations": [
    {
      "groupno": 1,
      "lineno": 1,
      "content": "部門コードが不要な取引です。部門コードを消去して読込みました"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "informations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "groupno": {
            "type": "number",
            "description": "事象が発生した仕訳グループ番号(送った仕訳単位で1から付番)"
          },
          "lineno": {
            "type": "number",
            "description": "事象が発生した仕訳明細の位置(※仕訳全体に関わる項目のエラーの場合null)"
          },
          "content": {
            "type": "string",
            "description": "内容"
          }
        }
      },
      "description": "みなし処理の内容(不要な値を送った場合に、文字列項目は空、数値項目は0で値をみなして更新する)"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errors": [
    {
      "groupno": 1,
      "is_ocr_dc": 1,
      "lineno": 1,
      "content": "勘定科目コードが入力されていないか、誤った勘定科目コードが入力されています"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "仕訳の論理的なチェックで引っかかった場合、またはjsonがparseできなかった場合、またはjsonschema(型チェック)で引っかかった場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "groupno": {
            "type": "number",
            "description": "事象が発生した仕訳グループ番号(送った仕訳単位で1から付番)"
          },
          "is_ocr_dc": {
            "type": "number",
            "description": "借方か貸方か(1:借方 0:貸方(※仕訳全体に関わる項目のエラーの場合null)"
          },
          "lineno": {
            "type": "number",
            "description": "事象が発生した仕訳明細の位置(※仕訳全体に関わる項目のエラーの場合null)"
          },
          "content": {
            "type": "string",
            "description": "内容"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errors": [
    {
      "message": "仕訳の更新権限がありません"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "更新をしようとしたユーザーに権限がない(仕訳の更新権限がない、部門をマスターに追加する際に部門の更新権限がない、取引先をマスターに追加する際に取引先の更新権限がない、口座をマスターに追加する際に口座の更新権限がない)"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

仕訳の更新API
POST/fx/{ocode}/{locale}/api/v2/slips/import

処理概要

  • 仕訳を更新する

  • 更新失敗時にはエラーの内容を取得する

ボディー部のスキーマ項目

slips
array (required) Example: []

仕訳(これ以降の項目は、slips内の項目)

ymd_tr
string (required) Example: 20220601

仕訳の取引年月日

  • 有効値: 以下の形式に対応
    • 8桁: 20220601
    • スラッシュ区切り: 2022/06/01(※2022/6/1のように、ゼロパディングされていない値は更新不可)
    • ハイフン区切り: 2022-06-01(※2022-6-1のように、ゼロパディングされていない値は更新不可)
journo
string (optional) Default: 空文字 Example: 1

伝票番号

  • 有効値: 半角数字(5 character)

  • ※「設定 > 基本情報 > 利用機能範囲の設定」メニューの「仕訳の入力設定」で、伝票番号を「システム自動付番」または「ユーザーごとシステム自動付番」の設定の場合は、システム側で自動で付番される

    • 「システム自動付番」または「ユーザーごとシステム自動付番」の設定の場合、入力した伝票番号の値は無視される

  • 上記の設定は、当ドキュメントの「仕訳の入力設定 > 仕訳の入力設定の取得」ＡＰＩで取得できる。取得した後に、自動付番される設定である場合は当項目は未指定とし、自動付番されない場合は呼び出し元のアプリケーション側で最後に振り出した番号を開始値を1として保持し、最後に振り出した番号にインクリメントする形で指定する

journo_read
string (optional) Default: 0 Example: 1

当該仕訳と連携元システムの取引とを対応させるための番号

  • 有効値: 半角数字(6 character)

  • ※連携元システムで会計帳簿を作成している場合、帳簿間の相互関連性を確認するために当番号を使用する。対応付けが不要な場合には、項目自体が不要（null）

vouno
string (optional) Default: 空文字 Example: 1

証憑番号

  • 有効値: 半角英数字(6 character)

  • ※「設定 > 基本情報 > 利用機能範囲の設定」メニューの「仕訳の入力設定」で、証憑番号を「数字のみ入力」の設定の場合、半角数字

cd_coopsystem
string (required) Example: EX

連携システムコード

  • ※API契約締結時に振り出したシステムコード
cd_fbcat
string (optional) Default: 空文字※資金相手科目で初期値が設定されている場合、その値になる Example: 01

収支区分

  • 有効値: 半角数字2桁(2 character)

  • ＦＸクラウドシリーズで「資金管理機能」を利用すると設定すると、「資金科目」と「非資金科目」の両方を含む仕訳を入力した際に「収支区分」と「内訳区分」の入力が必須入力となる

  • ※資金、非資金科目については「ＦＸクラウドシリーズの仕訳入力項目説明資料 (4) 勘定科目の資金管理」を参照

  • ※非資金科目に対して「設定＞勘定科目情報＞資金相手科目」で、伝票入力時の収支区分と内訳区分の初期値を設定できる。初期値が設定されている場合、当APIで収支区分と内訳区分が未入力であっても、自動で設定され更新される

  • 例えば非資金科目である「1211: 建物」に対して以下のような初期値を設定する

勘定科目 借方収支区分 借方内訳区分 貸方収支区分 貸方内訳区分
1211建物 03決算設備等支出 01償却資産購入 07他の財務等収入 03償却資産売却

  • 上記の設定の場合に、「1211:建物 / 資金科目」の取引の場合には、「収支区分03, 内訳区分01」が初期値になる

  • 「資金科目 / 1211:建物」の取引の場合には、「収支区分07, 内訳区分03」が初期値になる

cd_fbbdcat
string (optional) Default: 空文字※資金相手科目で初期値が設定されている場合、その値になる Example: 01

収支内訳区分

  • 有効値: 半角数字2桁(2 character)

  • ＦＸクラウドシリーズで「資金管理機能」を利用すると設定すると、「資金科目」と「非資金科目」の両方を含む仕訳を入力した際に「収支区分」と「内訳区分」の入力が必須入力

  • ※資金、非資金科目については「ＦＸクラウドシリーズの仕訳入力項目説明資料 (4) 勘定科目の資金管理」を参照

is_add_depmaster
number (optional) Default: 0 Example: 1

システム側に登録されていない部門コードを送った場合に、自動でマスターに追加するか否か

  • 有効値: 0~1

    • 1: 自動で追加する
    • 0: 追加しない

  • ※「設定 > 基本情報 > 利用機能範囲の設定」メニューの「部門別管理機能」で「部門別管理を利用する」の設定かつ、「科目配置基準」上で部門管理される科目を入力した場合に、部門コードが必須入力

    • 部門コードが必須入力かつ、マスターに存在しない部門コードを入力した際に、is_add_depmasterが1であれば部門マスターに自動で登録され、0であればエラー
is_add_cstmmaster
number (optional) Default: 0 Example: 1

システム側に登録されていない取引先コードを送った場合に、自動でマスターに追加するか否か

  • 有効値: 0~1

    • 1: 自動で追加する
    • 0: 追加しない

  • ※「設定 > 勘定科目情報 > 勘定科目」メニューで科目が取引先別元帳管理されている場合は、取引先コードが必須入力

    • ※マスターに存在しないコードを指定した場合かつ、is_add_cstmmasterが1の場合、自動でマスターに登録される
is_add_auxmaster
number (optional) Default: 0 Example: 1

システム側に登録されていない口座コードを送った場合に、自動でマスターに追加するか否か

  • 有効値: 0~1

    • 1: 自動で追加する
    • 0: 追加しない

  • ※「設定 > 勘定科目情報 > 勘定科目」メニューで科目が口座別元帳管理されている場合に、口座コードが必須入力

    • 口座コードが必須入力かつ、マスターに存在しない口座コードを入力した際に、is_add_auxmasterが1であれば口座マスターに自動で登録され、0であればエラー
detail
array (required) Example: []

仕訳の明細部(これ以降の項目は、detail内の項目)

  • ※合計で2000明細を超える仕訳を1回で送った場合、エラー
pos_dsp
number (required) Example: 1

仕訳明細の表示位置

  • 有効値: 1~60(1仕訳の明細部は最大60明細まで入力可能、61以上の値はエラー)

  • ※1仕訳に対して、同一の貸借、同一の表示位置に複数の仕訳を入力した場合、仕訳として正しくないためエラー

    • 例：借方１行目に複数明細を送った場合
is_ocr_dc
number (required) Example: 1

借方か貸方か

  • 有効値: 0~1

    • 1: 借方
    • 0: 貸方
cd_dep
string (optional) Default: 空文字 Example: 001

部門コード

  • 有効値: 半角数字(3 character)

  • ※「設定 > 基本情報 > 利用機能範囲の設定」メニューの「部門別管理機能」で「部門別管理を利用する」の設定かつ、「ＦＸクラウドシリーズの仕訳入力項目説明資料 １．ＴＫＣシステムの科目配置基準」上で部門管理される科目を入力した場合、必須入力

  • ※システムが部門別管理されているかつ、勘定科目が部門別管理されるているかつ、マスターに存在しないコードを指定した場合かつ、is_add_depmasterが1の場合、自動でマスターに登録される

nm_dep
string (optional) Default: 空文字 Example: 部門１

部門名

  • 有効値: 全角20、半角40文字まで入力可(40 character)

  • ※システムが部門別管理されているかつ、勘定科目が部門別管理されるているかつ、マスターに存在しないコードを指定した場合かつ、is_add_depmasterが1の場合、自動でマスターに登録される

  • ※部門コードがマスターに存在している場合、部門名の入力値は無視され、システムに登録されている部門名が更新される。

cd_act
string (required) Example: 1111

勘定科目コード

  • 有効値: 半角数字4桁(4 character)

  • 科目一覧については「ＦＸクラウドシリーズの仕訳入力項目説明資料 １．ＴＫＣシステムの科目配置基準」を参照

cd_auxact
string (optional) Default: 空文字 Example: A1

口座コード

  • 有効値: 半角大文字英数字2桁(2 character)

  • ※「設定 > 勘定科目情報 > 勘定科目」メニューで科目が口座別元帳管理されている場合は必須入力

  • ※勘定科目が口座別管理されているかつ、マスターに存在しないコードを指定した場合かつ、is_add_auxmasterが1の場合、自動でマスターに登録される

nm_auxact
string (optional) Default: 空文字 Example: 口座１

口座名

  • 有効値: 全角20、半角40文字まで入力可(40 character)

  • ※勘定科目が口座別管理されているかつ、マスターに存在しないコードを指定した場合かつ、is_add_auxmasterが1の場合、自動でマスターに登録される

  • ※口座コードがマスターに存在している場合、口座名の入力値は無視され、システムに登録されている口座名が更新される。

cd_cstm
string (optional) Default: 空文字 Example: 000001

取引先コード

  • 有効値: 半角数字6桁(6 character)

  • ※「設定 > 勘定科目情報 > 勘定科目」メニューで科目が取引先別元帳管理されている場合は必須入力

  • ※マスターに存在しないコードを指定した場合かつ、is_add_cstmmasterが1の場合、自動でマスターに登録される

nm_cstm
string (optional) Default: 空文字 Example: 取引先１

取引先名

  • 有効値: 全角20文字、半角40文字まで入力可(40 character)

  • システムに取引先が登録されていない取引先(随時の取引先)を入力したい場合には、取引先コードは入力せず、取引先名にのみ値を入力

  • ※マスターに存在しないコードを指定した場合かつ、is_add_cstmmasterが1の場合、自動でマスターに登録される

  • ※取引先コードがマスターに存在している場合、取引先名の入力値は無視され、システムに登録されている取引先名が更新される。

tptn
string (optional) Default: 空文字 Example: 1

課税区分

  • 有効値: 半角数字(2 character)

  • 「設定 > 基本情報 > 消費税情報」メニューの「消費税申告書自動作成区分・税額経理区分」で、「消費税申告書を作成する」の設定の場合には必須入力

  • ※入力値は「ＦＸクラウドシリーズの仕訳入力項目説明資料 ２．｢課税区分｣｢事業区分｣の使い方」を参照

tbptn
string (optional) Default: 空文字 Example: 1

事業区分

  • 有効値: 半角数字(2 character)

  • 「設定 > 基本情報 > 消費税情報」メニューの「主たる事業区分」で、主たる事業区分を管理する設定になっているかつ、課税区分が1または11を入力した場合には必須入力

  • ※入力値は「ＦＸクラウドシリーズの仕訳入力項目説明資料 ２．｢課税区分｣｢事業区分｣の使い方」を参照

amnt_tr
number (required) Example: 100000

取引金額

  • 有効値: -99999999999~99999999999
amnt_cmtx
number (optional) Default: 0 Example: 800

消費税額

  • 有効値: -99999999999~99999999999

  • ※「消費税申告書自動作成区分・税額経理区分」で、消費税申告書を作成する設定かつ、税抜き経理かつ、消費税が発生する取引の場合には必須入力

is_reduce_cmtxrate
number (optional) Default: 0 Example: 1

軽減税率か否か

  • 有効値: 0~1

    • 1: 軽減税率
    • 0: 通常税率(または税率発生なし)

  • ※「設定 > 基本情報 > 消費税情報」メニューの「消費税申告書自動作成区分・税額経理区分」で、消費税申告書を作成する設定かつ、税の発生する取引で、税の発生する課税区分を入力した場合は必須入力

cmtxrate
number (optional) Default: 0 Example: 800

消費税率

  • 税率を100倍した値を入力 例: 消費税率10%の取引の場合「取引金額：110000, 消費税額：10000, 消費税率：1000」

    • ※「設定 > 基本情報 > 消費税情報」メニューの「消費税申告書自動作成区分・税額経理区分」で、消費税申告書を作成する設定かつ、税の発生する取引で、税の発生する課税区分を入力した場合は必須入力
    • 「設定 > 基本情報 > 消費税情報」メニューの「税率テーブル」で登録されている消費税のみ入力が可能
    • 入力値は以下の表を参照（システム側で追加修正削除が可能なため、初期データを記載)
    税率 設定値
    5% 500
    8% 800
    10% 1000
is_autocalccmtx
number (optional) Default: 0 Example: 1

消費税額自動計算か否か

  • 有効値: 0~1

    • 1: 消費税額自動計算
    • 0: 自分で入力した税額(または消費税発生なし)

  • ※「1: 消費税額自動計算」であっても、取引金額と税率から求めた消費税額と、指定された消費税額が不一致であれば、0として更新する

cat_purday
string (optional) Default: 9 Example: 1

仕入れ日入力区分

  • 有効値: 0, 1, 2, 3, 4, 9

  • 仕入れの取引で、仕入れ年月日を入力する課税区分の場合には必須入力※「ＦＸクラウドシリーズの仕訳入力項目説明資料 ２．｢課税区分｣｢事業区分｣の使い方」を参照

ymd_purday1
string (optional) Default: 空文字 Example: 1

仕入れ日1(仕入日の始値)

  • 有効値: 以下の形式に対応

    • 8桁: 20220601
    • スラッシュ区切り: 2022/06/01(※2022/6/1のように、ゼロパディングされていない値は更新不可)
    • ハイフン区切り: 2022-06-01(※2022-6-1のように、ゼロパディングされていない値は更新不可)

  • 仕入れの取引で、仕入れ年月日を入力する課税区分の場合には必須入力※「ＦＸクラウドシリーズの仕訳入力項目説明資料 ２．｢課税区分｣｢事業区分｣の使い方」を参照

ymd_purday2
string (optional) Default: 空文字 Example: 1

仕入れ日2(仕入日の終値)

  • 有効値: 以下の形式に対応

    • 8桁: 20220601
    • スラッシュ区切り: 2022/06/01(※2022/6/1のように、ゼロパディングされていない値は更新不可)
    • ハイフン区切り: 2022-06-01(※2022-6-1のように、ゼロパディングされていない値は更新不可)

  • 仕入れの取引で、仕入れ年月日を入力する課税区分の場合には必須入力※「ＦＸクラウドシリーズの仕訳入力項目説明資料 ２．｢課税区分｣｢事業区分｣の使い方」を参照

  • 仕入れ日入力区分と、仕入れ日1、仕入れ日2の入力方法は以下の通り

    • ※仕入れ日入力区分が「月分」の入力区分だったとしても、仕入れ日としては年月日まで(1日固定)を入力する
    • 例えば、「2021年1月分」を入力する場合であっても、設定値は「20210101」とする
仕入れ日入力区分 入力形式 仕入れ日1 仕入れ日2
0 入力省略 null null
1 Z9年Z9月Z9日 20220101 null
2 Z9年Z9月Z9日～Z9年Z9月Z9日 20220101 20220201
3 Z9年Z9月分 20220101 null
4 Z9年Z9月分〜Z9年Z9月分 20220101 20220201
9 入力不要(仕入れ日が不要な取引) null null
rcj_slip
string (optional) Default: 空文字 Example: 摘要１

元帳摘要

  • 有効値: 全角40、半角80文字まで入力可(80 character)

みなし処理

  • 仕訳を更新する際に、みなし処理を行った場合には、その結果を返す

    • ※みなし処理: 不要な値を送った場合に、文字列項目は空、数値項目は0で値をみなして更新する
    • （例：「現金　/　当座預金」の仕訳に対して、税率や消費税額をいれた場合、そもそも消費税の発生する取引ではないため、税率や税額は0でみなして更新され、その旨がinformationsという項目で取得される）

  • この場合、項目としては本来不要なので、次回以降リクエストする際には、項目自体を送信しないでください

  • ※エラー、みなし処理で返ってくるメッセージに関してはこちらを参照

URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

勘定科目

科目の取得

GET /fx/tc09999001/tfa/api/v3/accounts?is_act_only=0&cat_fs=0&is_dsp_allaux=0
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "accounts": [
    {
      "cd_act": "1111",
      "nm_act": "現金",
      "kana_act": "ゲンキン",
      "cd_auxact": "",
      "nm_auxact": "",
      "kana_auxact": "",
      "cat_fs": 1,
      "is_dc": 1,
      "catcmtx": 2,
      "is_usedep": 0,
      "is_useauxact": 0,
      "is_usecstmldgr": 0,
      "is_fundapplc": 1,
      "cd_fbcat_dc": "01",
      "cd_fbbdcat_dc": "02",
      "cd_fbcat_cc": "02",
      "cd_fbbdcat_cc": "04"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cd_act": {
            "type": "string",
            "description": "勘定科目コード"
          },
          "nm_act": {
            "type": "string",
            "description": "勘定科目名"
          },
          "kana_act": {
            "type": "string",
            "description": "勘定科目フリガナ"
          },
          "cd_auxact": {
            "type": "string",
            "description": "口座コード"
          },
          "nm_auxact": {
            "type": "string",
            "description": "口座名"
          },
          "kana_auxact": {
            "type": "string",
            "description": "口座名フリガナ"
          },
          "cat_fs": {
            "type": "number",
            "description": "BS、PL、収支等、システムで扱う表の区分(1: 貸借対照表, 2: 損益計算書, 3: 製造原価報告書)"
          },
          "is_dc": {
            "type": "number",
            "description": "借方発生を加算するか否か(1: 借方を加算, 0: 貸方を加算)"
          },
          "catcmtx": {
            "type": "number",
            "description": "勘定科目の消費税属性(1：消費税が発生する, 2：消費税が発生しない, 3：仮払消費税, 4：仮受消費税  )"
          },
          "is_usedep": {
            "type": "number",
            "description": "部門管理している科目か否か(1: 部門管理している勘定科目, 0: 部門管理していない勘定科目)"
          },
          "is_useauxact": {
            "type": "number",
            "description": "口座管理している科目か否か(1: 口座管理している勘定科目, 0: 口座管理していない勘定科目)"
          },
          "is_usecstmldgr": {
            "type": "number",
            "description": "取引先別管理している科目か否か(1: 取引先別管理している勘定科目, 0: 取引先別管理していない勘定科目)"
          },
          "is_fundapplc": {
            "type": "number",
            "description": "資金科目か否か(1: 資金科目, 0: 非資金科目)"
          },
          "cd_fbcat_dc": {
            "type": "string",
            "description": "伝票入力時の借方資金収支区分コード初期値(01~12)"
          },
          "cd_fbbdcat_dc": {
            "type": "string",
            "description": "伝票入力時の借方資金収支内訳区分コード初期値(01~99)"
          },
          "cd_fbcat_cc": {
            "type": "string",
            "description": "伝票入力時の貸方資金収支区分コード初期値(01~12)"
          },
          "cd_fbbdcat_cc": {
            "type": "string",
            "description": "伝票入力時の貸方資金収支内訳区分コード初期値(01~99)"
          }
        },
        "required": [
          "cd_act",
          "nm_act",
          "kana_act",
          "cat_fs",
          "is_dc",
          "catcmtx",
          "is_usedep",
          "is_useauxact",
          "is_usecstmldgr",
          "is_fundapplc"
        ]
      },
      "description": "勘定科目一覧"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

科目一覧取得
GET/fx/{ocode}/{locale}/api/v3/accounts{?is_act_only,cat_fs,is_dsp_allaux}

処理概要

  • 勘定科目と口座の一覧を取得します

  • 資金管理の収支区分と内訳区分の初期値の情報もあわせて取得します

収支区分と内訳区分の初期値情報

  • ＦＸクラウドシリーズで「資金管理機能を利用する」と設定すると、「資金科目」と「非資金科目」の両方を 含む仕訳を入力した際に「収支区分」と「内訳区分」の入力が必須となります

    • ※詳しくは「ＦＸクラウドシリーズの仕訳入力項目説明資料 (4) 勘定科目の資金管理」を参照

  • 非資金科目に対して「設定＞勘定科目情報＞資金相手科目」で、伝票入力時の収支区分と内訳区分の初期値を設定できます

  • 例えば非資金科目である「1211: 建物」に対して以下のような初期値を設定します

勘定科目 借方収支区分 借方内訳区分 貸方収支区分 貸方内訳区分
1211建物 03決算設備等支出 01償却資産購入 07他の財務等収入 03償却資産売却

  • 上記の設定の場合に、「1211:建物 / 資金科目」の取引の場合には、「収支区分03, 内訳区分01」が初期値になります

  • 「資金科目 / 1211:建物」の取引の場合には、「収支区分07, 内訳区分03」が初期値になります

  • この初期値の情報は、当APIでは以下のように取得します

+ cd_act: 1211
    + nm_act: "建物"
    ~
    + is_fundapplc: 0
    + cd_fbcat_dc: 03
    + cd_fbbdcat_dc: 01
    + cd_fbcat_cc: 07
    + cd_fbbdcat_cc: 03
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

is_act_only
number (optional) Default: 0 Example: 0

勘定科目の情報のみを取得するか否か

  • 1: 勘定科目の情報のみを取得する

  • 0: 口座の情報もあわせて取得する

  • ※1だった場合、以下の項目は取得しない

    • cd_auxact: 口座コード
    • nm_auxact: 口座名
    • kana_auxact: 口座名フリガナ
cat_fs
number (optional) Example: 0

指定した諸表に表示する勘定科目科目のみ取得する(指定しなかった場合、全ての勘定科目を取得する)

  • 1：貸借対照表

  • 2：損益計算書

  • 3：製造原価報告書

is_dsp_allaux
number (optional) Default: 0 Example: 0

伝票入力画面で表示しない口座も含めて取得する(is_act_onlyが未指定、または0の場合のみ有効)

  • 1: すべての口座を取得する

  • 0: 一覧表示設定で表示するとした口座のみ取得する

科目の取得

GET /fx/tc09999001/tfa/api/v3/accounts/1111?is_act_only=0&cat_fs=0&is_dsp_allaux=0
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401404406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "accounts": [
    {
      "cd_act": "1114",
      "nm_act": "定期預金",
      "kana_act": "テイキヨキン",
      "cat_fs": 1,
      "is_dc": 1,
      "catcmtx": 2,
      "is_usedep": 0,
      "is_useauxact": 0,
      "is_usecstmldgr": 0,
      "is_fundapplc": 0,
      "cd_fbcat_dc": "05",
      "cd_fbbdcat_dc": "01",
      "cd_fbcat_cc": "07",
      "cd_fbbdcat_cc": "01"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cd_act": {
            "type": "string",
            "description": "勘定科目コード"
          },
          "nm_act": {
            "type": "string",
            "description": "勘定科目名"
          },
          "kana_act": {
            "type": "string",
            "description": "勘定科目フリガナ"
          },
          "cat_fs": {
            "type": "number",
            "description": "BS、PL、収支等、システムで扱う表の区分(1: 貸借対照表, 2: 損益計算書, 3: 製造原価報告書)"
          },
          "is_dc": {
            "type": "number",
            "description": "借方発生を加算するか否か(1: 借方を加算, 0: 貸方を加算)"
          },
          "catcmtx": {
            "type": "number",
            "description": "勘定科目の消費税属性(1：消費税が発生する, 2：消費税が発生しない, 3：仮払消費税, 4：仮受消費税)"
          },
          "is_usedep": {
            "type": "number",
            "description": "部門管理している勘定科目か否か(1: 部門管理している勘定科目, 0: 部門管理していない勘定科目)"
          },
          "is_useauxact": {
            "type": "number",
            "description": "口座管理している勘定科目か否か(1: 口座管理している勘定科目, 0: 口座管理していない勘定科目)"
          },
          "is_usecstmldgr": {
            "type": "number",
            "description": "取引先別管理している勘定科目か否か(1: 取引先別管理している勘定科目, 0: 取引先別管理していない勘定科目)"
          },
          "is_fundapplc": {
            "type": "number",
            "description": "資金科目か否か(1: 資金科目, 0: 非資金科目)"
          },
          "cd_fbcat_dc": {
            "type": "string",
            "description": "伝票入力時の借方資金収支区分コード初期値(01~12)"
          },
          "cd_fbbdcat_dc": {
            "type": "string",
            "description": "伝票入力時の借方資金収支内訳区分コード初期値(01~99)"
          },
          "cd_fbcat_cc": {
            "type": "string",
            "description": "伝票入力時の貸方資金収支区分コード初期値(01~12)"
          },
          "cd_fbbdcat_cc": {
            "type": "string",
            "description": "伝票入力時の貸方資金収支内訳区分コード初期値(01~99)"
          }
        },
        "required": [
          "cd_act",
          "nm_act",
          "kana_act",
          "cat_fs",
          "is_dc",
          "catcmtx",
          "is_usedep",
          "is_useauxact",
          "is_usecstmldgr",
          "is_fundapplc"
        ]
      },
      "description": "勘定科目情報"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errors": [
    {
      "message": "該当するデータがありません"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "存在しない勘定科目コードを指定した場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

指定した科目のみ取得
GET/fx/{ocode}/{locale}/api/v3/accounts/{cd_act}{?is_act_only,cat_fs,is_dsp_allaux}

処理概要

  • 指定した勘定科目と口座の情報を取得します
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

cd_act
string (required) Example: 1111

勘定科目コード

is_act_only
number (optional) Default: 0 Example: 0

勘定科目の情報のみを取得するか否か

  • 1: 勘定科目の情報のみを取得する

  • 0: 口座の情報もあわせて取得する

cat_fs
number (optional) Example: 0

指定した諸表に表示する勘定科目のみ取得する(指定しなかった場合、全ての勘定科目を取得する)

  • 1: 貸借対照表

  • 2: 損益計算書

  • 3: 製造原価報告書

is_dsp_allaux
number (optional) Default: 0 Example: 0

伝票入力画面で表示しない口座も含めて取得する(is_act_onlyが未指定、または0の場合のみ有効)

  • 1: すべての口座を取得する

  • 0: 一覧表示設定で表示するとした口座のみ取得する

消費税率

消費税率一覧の取得

GET /fx/tc09999001/tfa/api/v1/consumptiontaxrates?ymd_tr=20191001
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "consumptiontaxrates": [
    {
      "ymd_b": "2019-10-01",
      "ymd_e": "2019-12-31",
      "is_reduce_cmtxrate": 0,
      "cmtxrate": 1000
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "consumptiontaxrates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ymd_b": {
            "type": "string",
            "description": "税率適用開始年月日"
          },
          "ymd_e": {
            "type": "string",
            "description": "税率適用終了年月日 ※最新の税率の場合、終了年月日は項目自体存在しない"
          },
          "is_reduce_cmtxrate": {
            "type": "number",
            "description": "軽減税率か否か"
          },
          "cmtxrate": {
            "type": "number",
            "description": "税率"
          }
        },
        "required": [
          "ymd_b",
          "is_reduce_cmtxrate",
          "cmtxrate"
        ]
      },
      "description": "消費税率一覧"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

消費税率一覧取得
GET/fx/{ocode}/{locale}/api/v1/consumptiontaxrates{?ymd_tr}

処理概要

  • 指定した取引年月日の属する期間で、入力可能な消費税率の一覧を取得します
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

ymd_tr
string (optional) Example: 20191001

取引年月日

  • 有効値: 以下の形式に対応

    • 8桁: 20191001
    • スラッシュ区切り: 2019/10/01(※2019/10/1のように、ゼロパディングされていない値は指定不可)
    • ハイフン区切り: 2019-10-01(※2019-10-1のように、ゼロパディングされていない値は指定不可)

  • URLエンコードを行った文字列を渡します

  • 未指定の場合は全期間の税率を取得します

取引先

取引先の取得

GET /fx/tc09999001/tfa/api/v3/customers?is_dsp_all=0&cat_cstmrltn=1&keyword=鈴木&offset=1&limit=20&sort=nm_cstm,nm_cstmbo
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "total_count": 1000,
  "customers": [
    {
      "cd_cstm": "000001",
      "nm_cstm": "A商店",
      "kana_cstm": "エーショウテン",
      "initwd_cstm": "エー",
      "nm_cstmbo": "営業所１",
      "kana_cstmbo": "エイギョウショイチ",
      "phoneno1": "11122223333",
      "phoneno2": "44455556666",
      "is_adj": 0,
      "cat_cstmrltn": 1,
      "ord_dsp": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "total_count": {
      "type": "number",
      "description": "総取引先件数(取得していない分も含む)"
    },
    "customers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cd_cstm": {
            "type": "string",
            "description": "取引先コード"
          },
          "nm_cstm": {
            "type": "string",
            "description": "取引先名"
          },
          "kana_cstm": {
            "type": "string",
            "description": "取引先名フリガナ"
          },
          "initwd_cstm": {
            "type": "string",
            "description": "取引先頭文字"
          },
          "nm_cstmbo": {
            "type": "string",
            "description": "取引先営業所名"
          },
          "kana_cstmbo": {
            "type": "string",
            "description": "取引先営業所名フリガナ"
          },
          "phoneno1": {
            "type": "string",
            "description": "電話番号１"
          },
          "phoneno2": {
            "type": "string",
            "description": "電話番号２"
          },
          "is_adj": {
            "type": "number",
            "description": "その他取引先か否か(1: その他取引先, 0: 通常の取引先) ※特定の取引先に限らない仕訳に関しては、この取引先で仕訳を入力する"
          },
          "cat_cstmrltn": {
            "type": "number",
            "description": "取引先との関係区分(1: 得意先, 2: 仕入先, 3: 取引先＋仕入先, 4: その他)"
          },
          "ord_dsp": {
            "type": "number",
            "description": "表示順"
          }
        },
        "required": [
          "cd_cstm",
          "nm_cstm",
          "kana_cstm",
          "initwd_cstm",
          "nm_cstmbo",
          "kana_cstmbo",
          "phoneno1",
          "phoneno2",
          "is_adj",
          "cat_cstmrltn",
          "ord_dsp"
        ]
      },
      "description": "取引先一覧"
    }
  },
  "required": [
    "status",
    "total_count"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

取引先一覧取得
GET/fx/{ocode}/{locale}/api/v3/customers{?is_dsp_all,cat_cstmrltn,keyword,offset,limit,sort}

処理概要

  • 取引先の一覧を取得します
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

is_dsp_all
number (optional) Default: 0 Example: 0

伝票入力画面で表示しない取引先も含めて取得する

  • 1: すべての取引先を取得する

  • 0: 一覧表示設定で表示するとした取引先のみ取得する

cat_cstmrltn
number (optional) Default: 指定しない場合は全てのレコードを取得する Example: 1

取引先との関係区分での絞り込み

  • 1: 得意先

  • 2: 仕入先

  • 3: 取引先＋仕入先

  • 4: その他

keyword
string (optional) Default: 指定しない場合は全てのレコードを取得する Example: 鈴木

取引先名、取引先名カナ、営業所名、営業所カナ、電話番号に対してのあいまい検索

  • URLエンコードを行った文字列を渡します
offset
number (optional) Default: 0 Example: 1

取得レコードのオフセット

limit
number (optional) Default: 20 Example: 20

取得レコードの件数 (min: 1, max: 1000)

sort
string (optional) Default: ord_dspの昇順 Example: nm_cstm,nm_cstmbo

ソート項目の指定

  • ソートの指定が必要な場合、sort={項目名}と指定します

  • 降順の場合は項目名の直前に-を付与します

  • ソートの指定が可能なのは以下の項目です

    • cd_cstm: 取引先コード
    • nm_cstm: 取引先名
    • kana_cstm: 取引先名フリガナ
    • initwd_cstm: 取引先頭文字
    • nm_cstmbo: 取引先営業所名
    • kana_cstmbo: 取引先営業所名フリガナ
    • ord_dsp: 表示順

  • ※例

    • 取引先名昇順でソートする場合
      • ?sort=nm_cstm
    • 取引先名昇順、取引先営業所名昇順でソートする場合
      • ?sort=nm_cstm,nm_cstmbo
    • 取引先名降順、取引先営業所名降順でソートする場合
      • ?sort=-nm_cstm,-nm_cstmbo

  • 複数項目指定時、URLエンコードを行った文字列を渡します

取引先の取得

GET /fx/tc09999001/tfa/api/v3/customers/000001
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401404406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "customer": {
    "cd_cstm": "000001",
    "nm_cstm": "A商店",
    "kana_cstm": "エーショウテン",
    "initwd_cstm": "エー",
    "nm_cstmbo": "営業所１",
    "kana_cstmbo": "エイギョウショイチ",
    "phoneno1": "11122223333",
    "phoneno2": "44455556666",
    "is_adj": 0,
    "cat_cstmrltn": 1,
    "ord_dsp": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "customer": {
      "type": "object",
      "properties": {
        "cd_cstm": {
          "type": "string",
          "description": "取引先コード"
        },
        "nm_cstm": {
          "type": "string",
          "description": "取引先名"
        },
        "kana_cstm": {
          "type": "string",
          "description": "取引先名フリガナ"
        },
        "initwd_cstm": {
          "type": "string",
          "description": "取引先頭文字"
        },
        "nm_cstmbo": {
          "type": "string",
          "description": "取引先営業所名"
        },
        "kana_cstmbo": {
          "type": "string",
          "description": "取引先営業所名フリガナ"
        },
        "phoneno1": {
          "type": "string",
          "description": "電話番号１"
        },
        "phoneno2": {
          "type": "string",
          "description": "電話番号２"
        },
        "is_adj": {
          "type": "number",
          "description": "その他取引先か否か(1: その他取引先, 0: 通常の取引先) ※特定の取引先に限らない仕訳に関しては、この取引先で仕訳を入力する"
        },
        "cat_cstmrltn": {
          "type": "number",
          "description": "取引先との関係区分(1: 得意先, 2: 仕入先, 3: 取引先＋仕入先, 4: その他)"
        },
        "ord_dsp": {
          "type": "number",
          "description": "表示順"
        }
      },
      "required": [
        "cd_cstm",
        "nm_cstm",
        "kana_cstm",
        "initwd_cstm",
        "nm_cstmbo",
        "kana_cstmbo",
        "phoneno1",
        "phoneno2",
        "is_adj",
        "cat_cstmrltn",
        "ord_dsp"
      ],
      "additionalProperties": false,
      "description": "取引先情報"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errors": [
    {
      "message": "該当するデータがありません"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "存在しない取引先コードを指定した場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

指定した取引先のみ取得
GET/fx/{ocode}/{locale}/api/v3/customers/{cd_cstm}

処理概要

  • 指定した取引先の情報を取得します
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

cd_cstm
string (required) Example: 000001

取引先コード

部門

部門の取得

GET /fx/tc09999001/tfa/api/v2/departments?is_dsp_all=0
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "departments": [
    {
      "cd_dep": "001",
      "nm_dep": "A部門",
      "kana_dep": "エーブモン",
      "snm_dep": "エー",
      "is_adj": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cd_dep": {
            "type": "string",
            "description": "部門コード"
          },
          "nm_dep": {
            "type": "string",
            "description": "部門名"
          },
          "kana_dep": {
            "type": "string",
            "description": "部門名フリガナ"
          },
          "snm_dep": {
            "type": "string",
            "description": "部門名略称"
          },
          "is_adj": {
            "type": "number",
            "description": "共通部門か否か(1: 共通部門, 0: 通常の部門) ※特定の部門に限らない仕訳に関しては、この部門で仕訳を入力する"
          }
        },
        "required": [
          "cd_dep",
          "nm_dep",
          "kana_dep",
          "snm_dep",
          "is_adj"
        ]
      },
      "description": "部門一覧"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

部門一覧取得
GET/fx/{ocode}/{locale}/api/v2/departments{?is_dsp_all}

処理概要

  • 部門の一覧を取得します

  • 部門別管理機能を利用しない場合、0件でデータを取得します

URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

is_dsp_all
number (optional) Default: 0 Example: 0

伝票入力画面で表示しない部門も含めて取得する

  • 1: すべての部門を取得する

  • 0: 一覧表示設定で表示するとした部門のみ取得する

部門の取得

GET /fx/tc09999001/tfa/api/v2/departments/001
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401404406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "department": {
    "cd_dep": "001",
    "nm_dep": "A部門",
    "kana_dep": "エーブモン",
    "snm_dep": "エー",
    "is_adj": 0
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "department": {
      "type": "object",
      "properties": {
        "cd_dep": {
          "type": "string",
          "description": "部門コード"
        },
        "nm_dep": {
          "type": "string",
          "description": "部門名"
        },
        "kana_dep": {
          "type": "string",
          "description": "部門名フリガナ"
        },
        "snm_dep": {
          "type": "string",
          "description": "部門名略称"
        },
        "is_adj": {
          "type": "number",
          "description": "共通部門か否か(1: 共通部門, 0: 通常の部門) ※特定の部門に限らない仕訳に関しては、この部門で仕訳を入力する"
        }
      },
      "required": [
        "cd_dep",
        "nm_dep",
        "kana_dep",
        "snm_dep",
        "is_adj"
      ],
      "additionalProperties": false,
      "description": "部門情報"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errors": [
    {
      "message": "該当するデータがありません"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "存在しない部門コードを指定した場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

指定した部門のみ取得
GET/fx/{ocode}/{locale}/api/v2/departments/{cd_dep}

処理概要

  • 指定した部門の情報を取得します
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

cd_dep
string (required) Example: 001

部門コード

資金収支区分と資金収支内訳区分

資金収支区分と資金収支内訳区分の取得

GET /fx/tc09999001/tfa/api/v1/fundbalancebreakdowns
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "fundbalancebreakdowns": [
    {
      "cd_fbcat": "01",
      "nm_fbcat": "経常収入",
      "cd_fbbdcat": "01",
      "nm_fbbdcat": "現金売上"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "fundbalancebreakdowns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cd_fbcat": {
            "type": "string",
            "description": "資金収支区分コード"
          },
          "nm_fbcat": {
            "type": "string",
            "description": "資金収支区分名"
          },
          "cd_fbbdcat": {
            "type": "string",
            "description": "資金収支内訳区分コード"
          },
          "nm_fbbdcat": {
            "type": "string",
            "description": "資金収支内訳区分名"
          }
        },
        "required": [
          "cd_fbcat",
          "nm_fbcat",
          "cd_fbbdcat",
          "nm_fbbdcat"
        ]
      },
      "description": "資金収支区分内訳区分一覧"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

資金収支区分と資金収支内訳区分の一覧取得
GET/fx/{ocode}/{locale}/api/v1/fundbalancebreakdowns

処理概要

  • 資金収支区分と資金収支内訳区分の一覧を取得します

  • 資金管理機能を利用しない場合、0件でデータを取得します

URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

資金収支区分と資金収支内訳区分の取得

GET /fx/tc09999001/tfa/api/v1/fundbalancebreakdowns/01
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401404406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "fundbalancebreakdowns": [
    {
      "cd_fbcat": "01",
      "nm_fbcat": "経常収入",
      "cd_fbbdcat": "01",
      "nm_fbbdcat": "現金売上"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "fundbalancebreakdowns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cd_fbcat": {
            "type": "string",
            "description": "資金収支区分コード"
          },
          "nm_fbcat": {
            "type": "string",
            "description": "資金収支区分名"
          },
          "cd_fbbdcat": {
            "type": "string",
            "description": "資金収支内訳区分コード"
          },
          "nm_fbbdcat": {
            "type": "string",
            "description": "資金収支内訳区分名"
          }
        },
        "required": [
          "cd_fbcat",
          "nm_fbcat",
          "cd_fbbdcat",
          "nm_fbbdcat"
        ]
      },
      "description": "資金収支区分内訳区分一覧"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errors": [
    {
      "message": "該当するデータがありません"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "存在しない資金収支区分コードを指定した場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

指定した資金収支区分の情報のみ取得
GET/fx/{ocode}/{locale}/api/v1/fundbalancebreakdowns/{cd_fbcat}

処理概要

  • 指定した資金収支区分を取得する
URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

cd_fbcat
string (required) Example: 01

資金収支区分コード

仕訳の入力設定

仕訳の入力設定の取得

GET /fx/tc09999001/tfa/api/v1/inpjourconfig
Requestsexample 1
Headers
Content-Type: application/json
HTTP_X_REQUESTED_WITH: XMLHttpRequest
Authorization: Bearer {token}
Accept: application/json
Responses200401406
Headers
Content-Type: application/json
Body
{
  "status": 200,
  "inpjourconfig": {
    "is_auto_numbering_journo": true
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "成功"
    },
    "inpjourconfig": {
      "type": "object",
      "properties": {
        "is_auto_numbering_journo": {
          "type": "boolean",
          "description": "伝票番号の自動付番する設定か"
        }
      },
      "required": [
        "is_auto_numbering_journo"
      ],
      "additionalProperties": false,
      "description": "伝票番号の付番設定"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errors": [
    {
      "message": "トークンが存在しないか無効です",
      "code": "9002"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "トークンがないもしくはトークンが無効の場合"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          },
          "code": {
            "type": "string",
            "description": "エラーコード"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}
Headers
Content-Type: application/json
Body
{
  "status": 406,
  "errors": [
    {
      "message": "許可されていないフォーマットです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "フォーマットはJsonのみしかサポートしないため、.csv等のリクエストヘッダーの場合レスポンスを返さない"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "エラーメッセージ"
          }
        }
      },
      "description": "エラー内容"
    }
  },
  "required": [
    "status"
  ]
}

仕訳の入力設定の取得
GET/fx/{ocode}/{locale}/api/v1/inpjourconfig

処理概要

  • 仕訳の入力設定の取得します。

  • 現在、自動的に伝票番号を付番するかの設定のみを返します。

  • システム側で自動付番される設定の場合（「設定 > 基本情報 > 利用機能範囲の設定」メニューの「仕訳の入力設定」で、伝票番号を「システム自動付番」または「ユーザーごとシステム自動付番」の設定の場合）は、is_auto_numbering_journoがtrueを返します。

URI Parameters
HideShow
ocode
string (required) Example: tc09999001

企業コード

locale
string (required) Example: tfa

システム識別子

Generated by aglio on 07 Jun 2022