Community

コミュニティをご利用の際は 【ガイドライン】を確認・同意いただいた上でご利用ください。

※2021年6月25日(金)に、Community機能の提供を終了します。詳細はこちら

  • 投稿

    アバターfreee Developer Community

    勘定科目登録APIについて

    お世話になっております。

    勘定科目登録APIにて、収入取引相手勘定科目IDと支出取引相手勘定科目IDを指定する必要があるかと思いますが、ここには何を指定すればよいでしょうか?
    freeeのサイトにログインして画面上で登録する場合には選択候補が出てきますので、その候補一覧を取得してそれらのIDを指定すればよいのかと思っておりますが、認識合っておりますでしょうか?
    認識合っている場合、その候補一覧を取得する方法を教えていただけますでしょうか。
    認識間違っている場合、各勘定科目IDの指定方法を教えていただけますでしょうか。

    よろしくお願いいたします。

    • フォーラム「Community」には新規投稿および返信を追加できません。

    回答

    freee dev-supportfreee dev-support

    ご質問ありがとうございます。

    > 勘定科目登録APIにて、収入取引相手勘定科目IDと支出取引相手勘定科目IDを指定する必要があるかと思いますが、ここには何を指定すればよいでしょうか?

    相手勘定科目に設定したい勘定科目のIDをご指定ください。
    勘定科目IDは勘定科目のGETメソッドを利用して取得お願いします。

    相手勘定科目に関しましてはヘルプページでご確認ください。

    勘定科目の設定・追加を行う

    相手勘定科目に任意の科目を指定したいのですが、どうすればよいですか?

    アバターfreee Developer Community

    ご回答ありがとうございます。

    >相手勘定科目に設定したい勘定科目のIDをご指定ください。
    >勘定科目IDは勘定科目のGETメソッドを利用して取得お願いします。

    とのことですが、GETメソッドで取得できる勘定科目はすべて指定可能ということでしょうか?

    アバターfreee Developer Community

    すみません。
    追加で1点確認させていただけますでしょうか。

    group_name(決算書表示名)とaccount_category_id(勘定科目カテゴリーID)はSelectablesフォーム用選択項目情報エンドポイントaccount_groupsのnameとaccount_category_idで取得可能とありましたので、そこで取得した一覧の中から指定することになると思ったのですが、account_groupsは決算書表示名一覧を取得するエンドポイントであって勘定科目カテゴリー一覧を示すものではないのではないかと思います。(account_groups内のaccount_category_idは特定の決算書表示名に紐づく勘定科目カテゴリーIDを示すものという認識)

    勘定科目カテゴリーの指定候補一覧はどこから取得すればよいのでしょうか?

    freee dev-supportfreee dev-support

    ご確認ありがとうございます。

    > GETメソッドで取得できる勘定科目はすべて指定可能ということでしょうか?

    いえ指定できる項目は限られています。
    こちらをご確認ください。

    相手勘定科目に任意の科目を指定したいのですが、どうすればよいですか?

    > 勘定科目カテゴリーの指定候補一覧はどこから取得すればよいのでしょうか?

    Selectablesフォーム用選択項目情報エンドポイントで取得できる、
    account_groups が一覧となります。
    それそれ指定する値は、
    account_groups.name
    account_groups.account_category_id
    です。

    ご確認よろしくお願いいたします。

    アバターfreee Developer Community

    ご回答ありがとうございます。

    > いえ指定できる項目は限られています。
    > こちらをご確認ください。

    > 相手勘定科目に任意の科目を指定したいのですが、どうすればよいですか?
    具体的には相手勘定科目に設定可能なのはそれぞれ以下通りということで認識合っておりますでしょうか?

    ■収入取引相手勘定科目
    勘定科目一覧の取得用APIで以下のいずれかの条件を満たす勘定科目
    ・account_category(勘定科目カテゴリー)が「他流動資産」「他流動負債」のいずれか。
    ・name(勘定科目名)が「売掛金」「未収入金」「未収収益」のいずれか。

    ■支出取引相手勘定科目
    勘定科目一覧の取得用APIで以下のいずれかの条件を満たす勘定科目
    ・account_category(勘定科目カテゴリー)が「他流動資産」「他流動負債」のいずれか。
    ・name(勘定科目名)が「買掛金」「未払金」「未払費用」「未払消費税」「未払法人税」のいずれか。

    > Selectablesフォーム用選択項目情報エンドポイントで取得できる、
    > account_groups が一覧となります。
    > それそれ指定する値は、
    > account_groups.name
    > account_groups.account_category_id
    > です。
    account_groups.nameとaccount_groups.account_category_idがそれぞれ決算書表示名と勘定科目カテゴリーIDを示していることはわかります。
    ただ、実際にaccount_groupsで一覧を取得してみたところ、nameはユニークになっているようなのですがaccount_category_idが重複しているレコードが結構あり、ユニークではありませんでした。
    つまり、account_groupsは決算書表示名一覧を示すものであって勘定科目カテゴリーID一覧を示すものではありません。
    このことから、決算書表示名がaccount_groupsで取得したname一覧から指定するのはわかるのですが、勘定科目カテゴリーIDがaccount_groupsで取得したaccount_category_id一覧から指定するというのが理解できません。

    account_groupsで取得したaccount_category_id一覧から重複削除する必要があるということでしょうか?
    それとも、任意の決算書表示名にはaccount_groupsによって紐づいている勘定科目カテゴリーIDがあるので、勘定科目カテゴリーIDには指定した決算書表示名に紐づいている勘定科目カテゴリーIDを指定する必要があるということでしょうか?
    上記のいずれかであれば理解できるのですが、前者であればaccount_groupsで取得したaccount_category_id一覧は勘定科目カテゴリーIDの一覧にはなっていないため、別途勘定科目カテゴリーIDの一覧が取得できるAPIが欲しいです。
    後者であれば決算書表示名を指定すれば自動的に勘定科目カテゴリーIDは決まるのでわざわざAPIのパラメータに指定しないで御社システム内部で紐づけてほしいです。

    よろしくお願いします。

    アバターfreee Developer Community

    お世話になっております。

    御社サイトにログインして勘定科目の登録画面を表示してみたところ、勘定科目のカテゴリーを選択すると決算書表示名(小カテゴリー)の項目には勘定科目のカテゴリーの項目で選択した内容に応じた選択候補一覧が表示されることがわかりました。
    このことから前回質問させていただきました以下の内容で合っているということになるかと思います。

    > それとも、任意の決算書表示名にはaccount_groupsによって紐づいている勘定科目カテゴリーIDがあるので、勘定科目カテゴリーIDには指定した決算書表示名に紐づいている勘定科目カテゴリーIDを指定する必要があるということでしょうか?

    ただ、その場合前回の質問内容の通り決算書表示名が決まれば勘定科目カテゴリーIDは決まると思うのですが、APIのパラメータとしてあえて勘定科目カテゴリーIDも連携する理由は何かありますでしょうか?

    freee dev-supportfreee dev-support

    ご確認ありがとうございます。

    > ただ、その場合前回の質問内容の通り決算書表示名が決まれば勘定科目カテゴリーIDは決まると思うのですが、APIのパラメータとしてあえて勘定科目カテゴリーIDも連携する理由は何かありますでしょうか?

    確かに特定できるように思われます。
    こちらなにか特別な理由がないか担当のものに確認いたします。
    回答までお時間いただけると幸いです。

    引き続きどうぞよろしくお願いいたします。

    freee dev-supportfreee dev-support

    お時間頂きありがとうございます。
    確認が取れましたので回答いたします。

    ともに指定する理由は、Web上での操作と挙動をそろえるためとなっております。
    お手数おかけしてしまいますがご了承ください。

    よろしくお願いいたします。

    アバターfreee Developer Community

    回答ありがとうございます。
    承知いたしました。

    最後に1点だけ確認させていただけますでしょうか。
    勘定科目カテゴリーと決算書表示名はユーザに選択させようと思っているため、名称一覧を表示する必要があります。
    決算書表示名の一覧については確認させていただきました通り、Selectablesフォーム用選択項目情報エンドポイントaccount_groupsのnameにて取得可能かと思いますが、勘定科目カテゴリー名はどうやって取得すればよいでしょうか?
    正確には、決算書表示名のみ選択させ、決算書表示名が特定出来たらそれに紐づく勘定科目カテゴリー名を自動的に表示させようとしています。

    特定の決算書表示名に紐づく勘定科目カテゴリーIDはSelectablesフォーム用選択項目情報エンドポイントaccount_groupsのaccount_category_idにて取得可能ですが、そのIDに紐づく名称の取得方法が不明なため、質問させていただきました。

    勘定科目一覧取得APIで返却される項目に勘定科目カテゴリーと勘定科目カテゴリーIDがありますが、ここで取得すればよいかと思ったのですが、例えば勘定科目が1つも属していない勘定科目カテゴリーがあった場合勘定科目一覧取得APIでは確認できないと思ったのでですが、いかがでしょうか?
    もしすべての勘定科目カテゴリーは勘定科目一覧取得APIで返却される情報に含まれるということであればこのAPIを使用しようと考えています。

    ご回答よろしくお願いいたします。

    freee dev-supportfreee dev-support

    ご確認ありがとうございます。
    取り急ぎ勘定科目一覧で取得できるID,名称をご利用ください。

    この場合、ご指摘の通り勘定科目に紐付かないカテゴリが取得できなくなってしまいます。
    そのようなカテゴリの有無含めて確認いたします。

    お時間いただけると幸いです。
    引き続きどうぞよろしくお願いいたします。

    freee dev-supportfreee dev-support

    お時間頂きありがとうございます。

    現状、account_category_id に対応する category_name を取得するエンドポイントが存在しないため、
    取得できるエンドポイントを検討していまいります。

    そのため、前回お伝えした内容と重複してしまいますが、
    引き続き account_items での取得で代用ください。
    また、事業所によると思われますが、一部 account_items 上では category_name を取得できないケースを確認しています。
    その際は、ご不便をおかけしてしまいますが id 表示でご対応いただけると幸いです。
    一度作成することで、新たに作成した勘定科目から category_name を参照可能かと存じます。

    ご不便をおかけしてしまいますがご了承ください。
    よろしくお願いいたします。