APIのレスポンスに含まれる項目がドキュメントに記載のものより少ないです

エンドポイントによっては、「レスポンスグループ」の指定によって、レスポンスに含まれる項目が変わってきます。

APIドキュメントは、定義を示すためにすべての項目を記載していますが、デフォルトのレスポンスグループは「small」で、最小限の項目のみ含まれる状態になっています。そのため、これによる違いと考えられます。

＊レスポンスグループの指定が可能な場合は、APIドキュメントのクエリーパラメーター欄に「response_group」というパラメーターがあります。逆に、「response_group」がない場合はすべての項目が返ります。

以下、レスポングループの指定有無による違いを「顧客リスト取得API」を使って説明します。

「response_group」が未指定の場合、または「small」を指定した場合のレスポンスは以下のようになります。

curl --location 'https://api.the-board.jp/v1/clients' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

[
  {
    "id": 123456,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "サンプルビル3F",
    "tel": "03-0000-0000",
    "fax": "03-0000-0000",
    "payment_term_id": 123456,
    "payment_term_name": "月末締め翌月末払い",
    "company_number": "1234567890123",
    "invoice_system_number": "T1234567890123",
    "invoice_system_number_validated": true,
    "invoice_system_issuer_type": 1,
    "invoice_system_issuer_type_name": "該当する",
    "created_at": "2023-08-02T16:27:35.000+09:00",
    "updated_at": "2023-08-04T11:03:15.000+09:00"
  }
]

一方、「response_group」に「large」を指定した場合のレスポンスは以下のようになります。

curl --location 'https://api.the-board.jp/v1/clients?response_group=large' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

[
  {
    "id": 123456,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "サンプルビル3階",
    "tel": "03-0000-0000",
    "fax": "03-0000-0000",
    "title": "御中",
    "payment_term_id": 123456,
    "payment_term_name": "月末締め翌月末払い",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 0,
    "basic_agreement_flg": 0,
    "document_send_type": 1,
    "document_send_type_name": "メール(DL)",
    "note": "備考サンプルです",
    "tags": [
      "タグA",
      "タグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "サンプル（株）",
    "to": "test@example.com",
    "cc": "test@example.com",
    "invoice_system_number": "T1234567890123",
    "invoice_system_number_validated": true,
    "invoice_system_issuer_type": 0,
    "invoice_system_issuer_type_name": "未設定",
    "custom_no": "C0001",
    "company_bank_id": 123456,
    "company_bank_name": "サンプル銀行 サンプル支店",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "created_at": "2023-08-02T16:27:35.000+09:00",
    "updated_at": "2023-08-04T11:03:15.000+09:00"
  }
]

APIドキュメントの各エンドポイントのクエリーパラメーターにある「レスポンスグループ」の説明欄に、レスポンスに含まれる項目名が列挙されています。それを参考に、必要に応じて「response_group」を指定してください。