Class KENALL

constructor

• new KENALL(apikey: string, config?: Config): KENALL

  The constructor.

  Parameters

  • apikey: string

    The key string that you want to call the API with. The key is shown in the dashboard you will be navigated to right after signing in to the service.

  • config: Config = {}

    Specifies the configuration given by Config.

  Returns KENALL

Readonlyapibase

Readonlyapikey

Readonlytimeout

checkBusinessDay

• checkBusinessDay(date: string): Promise<v20250101.BusinessDayCheckResponse>

  "checkBusinessDay" API (エンドポイント: /businessdays/check) を呼び出します。

  このAPIはバージョン管理されていません。

  Parameters

  • date: string

    "checkBusinessDay" API (エンドポイント: /businessdays/check) を呼び出します。

    このAPIはバージョン管理されていません。

  Returns Promise<v20250101.BusinessDayCheckResponse>

  A BusinessDayCheckResponse.

getAddress

• getAddress<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      postalCode: string,
      version?: string,
      apiVersion?: T,
  ): Promise<AddressResolverResponseForVersion<T>>

  "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • postalCode: string

    "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。

  • Optionalversion: string

    "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。

  • OptionalapiVersion: T

    "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。

  Returns Promise<AddressResolverResponseForVersion<T>>

  An AddressResolverResponse.

getBank

• getBank<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      bankCode: string,
      apiVersion?: T,
  ): Promise<BankResolverResponseForVersion<T>>

  Invokes "getBank" API (endpoint: /bank/{bankCode}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankResolverResponseForVersion<T>>

  A BankResolverResponse.

getBankBranch

• getBankBranch<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      bankCode: string,
      branchCode: string,
      apiVersion?: T,
  ): Promise<BankBranchResolverResponseForVersion<T>>

  Invokes "getBankBranch" API (endpoint: /bank/{bankCode}/branches/{branchCode}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • branchCode: string

    The branch code to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankBranchResolverResponseForVersion<T>>

  A BankBranchResolverResponse.

getBankBranches

• getBankBranches<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      bankCode: string,
      apiVersion?: T,
  ): Promise<BankBranchesResponseForVersion<T>>

  Invokes "getBankBranch" API (endpoint: /bank/{bankCode}/branches).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankBranchesResponseForVersion<T>>

  A BankBranchesResponse.

getBanks

• getBanks<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      apiVersion?: T,
  ): Promise<BanksResponseForVersion<T>>

  Invokes "getBanks" API (endpoint: /bank).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BanksResponseForVersion<T>>

  A BanksResponse.

getCities

• getCities<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      prefectureCode: string,
      version?: string,
      apiVersion?: T,
  ): Promise<CityResolverResponseForVersion<T>>

  "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • prefectureCode: string

    "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。

  • Optionalversion: string

    "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。

  • OptionalapiVersion: T

    "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。

  Returns Promise<CityResolverResponseForVersion<T>>

  A CityResolverResponse.

getHolidays

• getHolidays(
      options?: v20250101.HolidaysOptions,
  ): Promise<v20250101.HolidaysResponse>

  "getHolidays" API (エンドポイント: /holidays) を呼び出します。

  このAPIはバージョン管理されていません。

  Parameters

  • options: v20250101.HolidaysOptions = {}

    "getHolidays" API (エンドポイント: /holidays) を呼び出します。

    このAPIはバージョン管理されていません。

  Returns Promise<v20250101.HolidaysResponse>

  A HolidaysResponse.

getNTACorporateInfo

• getNTACorporateInfo<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      corporateNumber: string,
      apiVersion?: T,
  ): Promise<NTACorporateInfoResolverResponseForVersion<T>>

  "getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • corporateNumber: string

    "getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。

  • OptionalapiVersion: T

    "getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。

  Returns Promise<NTACorporateInfoResolverResponseForVersion<T>>

  An NTACorporateInfoResolverResponse.

getNTAQualifiedInvoiceIssuerInfo

• getNTAQualifiedInvoiceIssuerInfo<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      issuerNumber: string,
      apiVersion?: T,
  ): Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>

  "getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • issuerNumber: string

    "getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。

  • OptionalapiVersion: T

    "getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。

  Returns Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>

  An NTAQualifiedInvoiceIssuerInfoResolverResponse.

getSchool

• getSchool(schoolCode: string): Promise<v20250101.SchoolResolverResponse>

  "getSchool" API (エンドポイント: /school/{schoolCode}) を呼び出します。

  このAPIはバージョン管理されていません。

  Parameters

  • schoolCode: string

    "getSchool" API (エンドポイント: /school/{schoolCode}) を呼び出します。

    このAPIはバージョン管理されていません。

  Returns Promise<v20250101.SchoolResolverResponse>

  A SchoolResolverResponse.

searchAddresses

• searchAddresses<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      options: v20221101.AddressSearcherOptions,
      apiVersion?: T,
  ): Promise<AddressSearcherResponseForVersion<T>>

  "searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • options: v20221101.AddressSearcherOptions

    "searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。

  • OptionalapiVersion: T

    "searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。

  Returns Promise<AddressSearcherResponseForVersion<T>>

  An AddressSearcherResponse.

searchNTACorporateInfo

• searchNTACorporateInfo<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | undefined = undefined,
  >(
      options: v20221101.NTACorporateInfoSearcherOptions,
      apiVersion?: T,
  ): Promise<NTACorporateInfoSearcherResponseForVersion<T>>

  "searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | undefined = undefined

  Parameters

  • options: v20221101.NTACorporateInfoSearcherOptions

    "searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。

  • OptionalapiVersion: T

    "searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。

  Returns Promise<NTACorporateInfoSearcherResponseForVersion<T>>

  An NTACorporateInfoSearcherResponse.

searchSchool

• searchSchool(
      options: v20250101.SchoolSearcherOptions,
  ): Promise<v20250101.SchoolSearcherResponse>

  "searchSchool" API (エンドポイント: /school/?...) を呼び出します。

  このAPIはバージョン管理されていません。

  Parameters

  • options: v20250101.SchoolSearcherOptions

    "searchSchool" API (エンドポイント: /school/?...) を呼び出します。

    このAPIはバージョン管理されていません。

  Returns Promise<v20250101.SchoolSearcherResponse>

  A SchoolSearcherResponse.

whoami

• whoami(): Promise<v20250101.WhoamiResponse>

  "whoami" API (エンドポイント: /whoami) を呼び出します。

  このAPIはバージョン管理されていません。

  Returns Promise<v20250101.WhoamiResponse>

  A WhoamiResponse that contains the IP address the request was made from.