Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 7.91 KB

TimeEntriesApi.md

File metadata and controls

392 lines (255 loc) · 7.91 KB
Raw

Connectwise::TimeEntriesApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
time_entries_count_get GET /time/entries/count
time_entries_get GET /time/entries
time_entries_id_delete DELETE /time/entries/{id}
time_entries_id_get GET /time/entries/{id}
time_entries_id_patch PATCH /time/entries/{id}
time_entries_id_put PUT /time/entries/{id}
time_entries_post POST /time/entries

time_entries_count_get

Count time_entries_count_get(opts)

Get Time Entries Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.time_entries_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_count_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

time_entries_get

Array<TimeEntry> time_entries_get(opts)

Get Time Entries

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.time_entries_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]
order_by String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<TimeEntry>

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

time_entries_id_delete

time_entries_id_delete(id)

Delete Time Entry By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

id = 56 # Integer | 


begin
  api_instance.time_entries_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

time_entries_id_get

TimeEntry time_entries_id_get(id)

Get Time Entry By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

id = 56 # Integer | 


begin
  result = api_instance.time_entries_id_get(id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

TimeEntry

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

time_entries_id_patch

TimeEntry time_entries_id_patch(id, operations)

Update Time Entry

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

id = 56 # Integer | 

operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.time_entries_id_patch(id, operations)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

TimeEntry

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

time_entries_id_put

TimeEntry time_entries_id_put(id, time_entry)

Replace Time Entry

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

id = 56 # Integer | 

time_entry = Connectwise::TimeEntry.new # TimeEntry | 


begin
  result = api_instance.time_entries_id_put(id, time_entry)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
time_entry TimeEntry

Return type

TimeEntry

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

time_entries_post

TimeEntry time_entries_post(time_entry)

Create Time Entry

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::TimeEntriesApi.new

time_entry = Connectwise::TimeEntry.new # TimeEntry | 


begin
  result = api_instance.time_entries_post(time_entry)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TimeEntriesApi->time_entries_post: #{e}"
end

Parameters

Name Type Description Notes
time_entry TimeEntry

Return type

TimeEntry

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json