Project

kendama

0.0
The project is in a healthy, maintained state
国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのRuby向けラッパーです。
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 3.6, >= 3.6.0

Runtime

~> 1.0, >= 1.0.1
 Project Readme

kendama

Kendama - the Ruby gem for the 国税庁API

国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build kendama.gemspec

Then either install the gem locally:

gem install ./kendama-1.0.0.gem

(for development, run gem install --dev ./kendama-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'kendama', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/uichi/kendama, then add the following in the Gemfile:

gem 'kendama', :git => 'https://github.com/uichi/kendama.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'kendama'

api_instance = Kendama::V1Api.new
id = 'id_example' # String | 
from = Date.parse('Tue Oct 01 09:00:00 JST 2024') # Date | 
to = Date.parse('Tue Oct 01 09:00:00 JST 2024') # Date | 
type = '21' # String | 
opts = {
  division: '1', # String | 
  divide: 'divide_example' # String | 
}

begin
  #取得期間を指定して情報を取得
  result = api_instance.get_announcement_by_diff(id, from, to, type, opts)
  p result
rescue Kendama::ApiError => e
  puts "Exception when calling V1Api->get_announcement_by_diff: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://kensyo.invoice-kohyo.nta.go.jp

Class Method HTTP request Description
Kendama::V1Api get_announcement_by_diff GET /1/diff 取得期間を指定して情報を取得
Kendama::V1Api get_announcement_by_number GET /1/num 登録番号を指定して情報を取得
Kendama::V1Api get_announcement_by_valid GET /1/valid 登録番号と日付を指定して情報を取得

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.