Community

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

  • 投稿

    アバターson

    各APIのデータ項目の仕様についての確認事項

    各APIのデータ項目の仕様についての確認事項です。
    (1)APIのリファレンス資料の中で、Integerのデータの最大値の記述がありますが、Stringデータの桁数の記述がないです。
       登録できるStringデータの最大桁数の情報はどこにありますか?
    (2)POSTするとき、Integerの項目の値を渡していないとき、テーブルにDefault値として0に登録されるという認識が合っていますか?
    (3)PUTするとき、APIで渡している項目だけ更新され、渡されていない項目を更新しないと認識が合っていますか?
    (4)各テーブルのPrimary Keyの情報はどこにありますか?
    (5)同じデータを連続POSTするとき、2重登録エラーになりますか?
    (6)取引、振替仕訳などのPOST、PUTのAPIでテーブルのデータを新規登録、更新するとき、
       使用されている各コード(事業者ID、勘定科目、取引先など)の存在チェックが実施されていますか?
       存在しない場合、どのようかエラー情報が返しますか?

    以上、宜しくお願い致します。

    回答

    freee dev-supportfreee dev-support

    お世話になっております。
    お問い合わせありがとうございます。

    ⑴について
    基本的に「Stringデータ」についても最大件数の記載はございます。
    記載は各APIのパラメータ詳細を開くことで確認することが出来ます。
    (画像を添付いたします)

    記載がないものは、任意な「Stringデータ」を設定できなく、【会計freee上に存在する情報】を指定していただく必要があるためです。

    ⑵について
    Integerの項目の値を渡していないときは、「0」ではなく「null」という扱いで連携されます。

    ⑶について
    はい、お客様のご認識の通りでございます。

    ⑷について
    大変恐縮ではございますが、現在確認しております。
    確認でき次第、改めて回答させていただきます。

    ⑸について
    基本的にはエラーになりません。
    しかし、同時のリクエストと認識され、データに不整合が発生しないようにロックがかかってしまいエラーとなる可能性がございます。

    その際は、お時間をおいて再度お試しいただくようになりますので、予めご了承くださいませ。

    ⑹について
    PUTやPOSTをする際は、リクエストをする会計freeeの事業所に存在されているID以外を指定するとエラーとして返ってきます。
    “type”: “status”,
    “messages”:[“不正なリクエストです。”]},
    {“type”: “validation”,
    “messages”:[“Details 存在しない account_item_id が含まれています。”
    など、「messages」部分にエラーとなる原因が表示されます

    ※今回は勘定科目IDですが、取引先IDについても同様です。

    事業所IDの場合は下記のようになります。
    type”: “status”,
    “messages”:[“アクセス権限がありません。”,
    “api/v1/deals”,
    “create”,
    “存在しないかすでに削除された事業所です。”

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

    Attachments:
    freee dev-supportfreee dev-support

    お時間をいただいており、申し訳ございません。

    ⑷について
    恐れ入りますが、こちらはAPIを叩くときの必須パラメータのことをお考えでしょうか?

    弊社の場合、JSON形式になってしまうため、お客様が考えている内容をご教示いただけますと幸いです。

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

    アバターson

    (4)の質問の意図は、こちらでPOST APIを発行するとき、どのような場合2重登録になりを知りたいです。たとえば、勘定科目データをPOSTするとき、同じ名称の勘定科目を登録できるかどうか。

    取引(支出/入金)のデータをPOSTするときに、同じデータを重複できること、同じの振替仕訳データを重複できないことをこちらでAPI経由して確認しました。

    このような情報を事前にわかっているならば、APIデータをPOSTする前に、2重登録しないようにチェック処理を追加したいです。

    freee dev-supportfreee dev-support

    ご教示ありがとうございます。

    2重登録しないようにチェック処理を追加したいということでございますね。

    2重登録にならないようエラーとなるのは、会計freee上の挙動と同じでございます。

    つまり、マスター情報(勘定科目の作成、更新など)の新規登録や編集を行う場合は
    ・新規登録される名称(account_itemのname)がすでに登録されていないか
    ・勘定科目を更新する場合も名称(account_itemのname)がすでに登録されていないか
    にて2重登録になるかならないかの判断をしております。

    ※ほかのマスター情報についても、「Parametersの各マスター情報のname」がキーになります。

    ほかには請求書APIですが、会計freeeでは請求書番号を同じで登録することができない仕様でございます。
    そのため、APIも請求書番号(invoice_number)にて2重登録のチェックが行われます。

    そのほかには、特にチェックがない認識でおりますので、エラー等になってしまう場合はご指摘いただけますと幸いです。
    どうぞよろしくお願いいたします。