Skip to content

VatReturnscommentApi.md

Latest commit

 

History

History
148 lines (110 loc) · 4.33 KB

VatReturnscommentApi.md

File metadata and controls

148 lines (110 loc) · 4.33 KB

TripletexRubyClient::VatReturnscommentApi

All URIs are relative to https://tripletex.no/v2

Method HTTP request Description
all GET /vatReturns/comment/>all [BETA] - Get all structured comments available
query GET /vatReturns/comment [BETA] - Get all structured comments related to a given vatCode

all

ListResponseVatReturnsComment all(opts)

[BETA] - Get all structured comments available

Example

# load the gem
require 'tripletex_ruby_client'
# setup authorization
# # Setup authorization - as autogenerated by swagger-codegen
# TripletexRubyClient.configure do |config|
#   # Configure HTTP basic authorization: tokenAuthScheme
#   config.username = 'YOUR USERNAME'
#   config.password = 'YOUR PASSWORD'
# end
# Setup authorization
# 
TripletexRubyClient.configure do |config|
  # Configure HTTP basic authorization: tokenAuthScheme
  config.consumer_token = ENV["TT_CONSUMER_TOKEN"]
  config.employee_token = ENV["TT_EMPLOYEE_TOKEN"]
  config.host = Rails.env.production? ? 'https://tripletex.no' : 'https://api.tripletex.io'
  config.token_expiration_time = Rails.env.production? ? 1.month : 1.day
end
api_instance = TripletexRubyClient::VatReturnscommentApi.new

opts = { 
  from: 0, # Integer | From index
  count: 1000, # Integer | Number of elements to return
  sorting: 'sorting_example', # String | Sorting pattern
  fields: 'fields_example' # String | Fields filter pattern
}

begin
  #[BETA] - Get all structured comments available
  result = api_instance.all(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling VatReturnscommentApi->all: #{e}"
end

Parameters

Name Type Description Notes
from Integer From index [optional] [default to 0]
count Integer Number of elements to return [optional] [default to 1000]
sorting String Sorting pattern [optional]
fields String Fields filter pattern [optional]

Return type

ListResponseVatReturnsComment

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

query

ListResponseVatReturnsVatCodeCommentDTO query(opts)

[BETA] - Get all structured comments related to a given vatCode

Example

# load the gem
require 'tripletex_ruby_client'
# setup authorization
# # Setup authorization - as autogenerated by swagger-codegen
# TripletexRubyClient.configure do |config|
#   # Configure HTTP basic authorization: tokenAuthScheme
#   config.username = 'YOUR USERNAME'
#   config.password = 'YOUR PASSWORD'
# end
# Setup authorization
# 
TripletexRubyClient.configure do |config|
  # Configure HTTP basic authorization: tokenAuthScheme
  config.consumer_token = ENV["TT_CONSUMER_TOKEN"]
  config.employee_token = ENV["TT_EMPLOYEE_TOKEN"]
  config.host = Rails.env.production? ? 'https://tripletex.no' : 'https://api.tripletex.io'
  config.token_expiration_time = Rails.env.production? ? 1.month : 1.day
end
api_instance = TripletexRubyClient::VatReturnscommentApi.new

opts = { 
  from: 0, # Integer | From index
  count: 1000, # Integer | Number of elements to return
  sorting: 'sorting_example', # String | Sorting pattern
  fields: 'fields_example' # String | Fields filter pattern
}

begin
  #[BETA] - Get all structured comments related to a given vatCode
  result = api_instance.query(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling VatReturnscommentApi->query: #{e}"
end

Parameters

Name Type Description Notes
from Integer From index [optional] [default to 0]
count Integer Number of elements to return [optional] [default to 1000]
sorting String Sorting pattern [optional]
fields String Fields filter pattern [optional]

Return type

ListResponseVatReturnsVatCodeCommentDTO

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined