TripletexRubyClient::TimesheetmonthApi

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

Method	HTTP request	Description
approve	PUT /timesheet/month/:approve	approve month(s). If id is provided the other args are ignored
complete	PUT /timesheet/month/:complete	complete month(s). If id is provided the other args are ignored
get	GET /timesheet/month/{id}	Find monthly status entry by ID.
get_by_month_number	GET /timesheet/month/byMonthNumber	Find monthly status for given month.
reopen	PUT /timesheet/month/:reopen	reopen month(s). If id is provided the other args are ignored
unapprove	PUT /timesheet/month/:unapprove	unapprove month(s). If id is provided the other args are ignored

approve

ListResponseMonthlyStatus approve(opts)

approve month(s). If id is provided the other args are ignored

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::TimesheetmonthApi.new

opts = { 
  id: 56, # Integer | Element ID
  employee_ids: 'employee_ids_example', # String | List of IDs. Defaults to ID of token owner.
  month_year: 'month_year_example', # String | 2020-01
  approved_until_date: 'approved_until_date_example' # String | yyyy-MM-dd. Defaults to today.. Defaults to end of month
}

begin
  #approve month(s).  If id is provided the other args are ignored
  result = api_instance.approve(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling TimesheetmonthApi->approve: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID	[optional]
employee_ids	String	List of IDs. Defaults to ID of token owner.	[optional]
month_year	String	2020-01	[optional]
approved_until_date	String	yyyy-MM-dd. Defaults to today.. Defaults to end of month	[optional]

Return type

ListResponseMonthlyStatus

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

complete

ListResponseMonthlyStatus complete(opts)

complete month(s). If id is provided the other args are ignored

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::TimesheetmonthApi.new

opts = { 
  id: 56, # Integer | Element ID
  employee_ids: 'employee_ids_example', # String | List of IDs. Defaults to ID of token owner.
  month_year: 'month_year_example' # String | 2020-01
}

begin
  #complete month(s).  If id is provided the other args are ignored
  result = api_instance.complete(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling TimesheetmonthApi->complete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID	[optional]
employee_ids	String	List of IDs. Defaults to ID of token owner.	[optional]
month_year	String	2020-01	[optional]

Return type

ListResponseMonthlyStatus

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

get

ResponseWrapperMonthlyStatus get(id, opts)

Find monthly status entry by ID.

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::TimesheetmonthApi.new

id = 56 # Integer | Element ID

opts = { 
  fields: 'fields_example' # String | Fields filter pattern
}

begin
  #Find monthly status entry by ID.
  result = api_instance.get(id, opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling TimesheetmonthApi->get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID
fields	String	Fields filter pattern	[optional]

Return type

ResponseWrapperMonthlyStatus

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

get_by_month_number

ListResponseMonthlyStatus get_by_month_number(employee_ids, month_year, opts)

Find monthly status for given month.

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::TimesheetmonthApi.new

employee_ids = 'employee_ids_example' # String | List of IDs. Defaults to ID of token owner.

month_year = 'month_year_example' # String | 2020-01

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
  #Find monthly status for given month.
  result = api_instance.get_by_month_number(employee_ids, month_year, opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling TimesheetmonthApi->get_by_month_number: #{e}"
end

Parameters

Name	Type	Description	Notes
employee_ids	String	List of IDs. Defaults to ID of token owner.
month_year	String	2020-01
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

ListResponseMonthlyStatus

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

reopen

ListResponseMonthlyStatus reopen(opts)

reopen month(s). If id is provided the other args are ignored

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::TimesheetmonthApi.new

opts = { 
  id: 56, # Integer | Element ID
  employee_ids: 'employee_ids_example', # String | List of IDs. Defaults to ID of token owner.
  month_year: 'month_year_example' # String | 2020-01
}

begin
  #reopen month(s).  If id is provided the other args are ignored
  result = api_instance.reopen(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling TimesheetmonthApi->reopen: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID	[optional]
employee_ids	String	List of IDs. Defaults to ID of token owner.	[optional]
month_year	String	2020-01	[optional]

Return type

ListResponseMonthlyStatus

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

unapprove

ListResponseMonthlyStatus unapprove(opts)

unapprove month(s). If id is provided the other args are ignored

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::TimesheetmonthApi.new

opts = { 
  id: 56, # Integer | Element ID
  employee_ids: 'employee_ids_example', # String | List of IDs. Defaults to ID of token owner.
  month_year: 'month_year_example' # String | 2020-01
}

begin
  #unapprove month(s).  If id is provided the other args are ignored
  result = api_instance.unapprove(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling TimesheetmonthApi->unapprove: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID	[optional]
employee_ids	String	List of IDs. Defaults to ID of token owner.	[optional]
month_year	String	2020-01	[optional]

Return type

ListResponseMonthlyStatus

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TripletexRubyClient::TimesheetmonthApi

approve

Example

Parameters

Return type

Authorization

HTTP request headers

complete

Example

Parameters

Return type

Authorization

HTTP request headers

get

Example

Parameters

Return type

Authorization

HTTP request headers

get_by_month_number

Example

Parameters

Return type

Authorization

HTTP request headers

reopen

Example

Parameters

Return type

Authorization

HTTP request headers

unapprove

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

TimesheetmonthApi.md

Latest commit

History

TimesheetmonthApi.md

File metadata and controls

TripletexRubyClient::TimesheetmonthApi

approve

Example

Parameters

Return type

Authorization

HTTP request headers

complete

Example

Parameters

Return type

Authorization

HTTP request headers

get

Example

Parameters

Return type

Authorization

HTTP request headers

get_by_month_number

Example

Parameters

Return type

Authorization

HTTP request headers

reopen

Example

Parameters

Return type

Authorization

HTTP request headers

unapprove

Example

Parameters

Return type

Authorization

HTTP request headers