Skip to content

ChangeOrderApi.md

Latest commit

 

History

History
365 lines (262 loc) · 10.3 KB

ChangeOrderApi.md

File metadata and controls

365 lines (262 loc) · 10.3 KB

ConnectWise::ChangeOrderApi

All URIs are relative to http://na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
delete_procurement_changeorder_by_id DELETE /procurement/changeorder/{id} Deletes ChangeOrder By Id
get_procurement_changeorder GET /procurement/changeorder Get List of ChangeOrders
get_procurement_changeorders_count GET /procurement/changeorders/count Get Count of changeOrders
patch_procurement_changeorder_by_id PATCH /procurement/changeorder/{id} Patch ChangeOrder
post_procurement_changeorder POST /procurement/changeorder Post ChangeOrder

delete_procurement_changeorder_by_id

delete_procurement_changeorder_by_id(id, client_id)

Deletes ChangeOrder By Id

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ChangeOrderApi.new
id = 56 # Integer | ChangeOrderId
client_id = 'client_id_example' # String | 

begin
  # Deletes ChangeOrder By Id
  api_instance.delete_procurement_changeorder_by_id(id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->delete_procurement_changeorder_by_id: #{e}"
end

Using the delete_procurement_changeorder_by_id_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_procurement_changeorder_by_id_with_http_info(id, client_id)

begin
  # Deletes ChangeOrder By Id
  data, status_code, headers = api_instance.delete_procurement_changeorder_by_id_with_http_info(id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->delete_procurement_changeorder_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer ChangeOrderId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_procurement_changeorder

<Array> get_procurement_changeorder(client_id, opts)

Get List of ChangeOrders

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ChangeOrderApi.new
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get List of ChangeOrders
  result = api_instance.get_procurement_changeorder(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->get_procurement_changeorder: #{e}"
end

Using the get_procurement_changeorder_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> get_procurement_changeorder_with_http_info(client_id, opts)

begin
  # Get List of ChangeOrders
  data, status_code, headers = api_instance.get_procurement_changeorder_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<ChangeOrder>>
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->get_procurement_changeorder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

Array<ChangeOrder>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2025.1

get_procurement_changeorders_count

get_procurement_changeorders_count(client_id, opts)

Get Count of changeOrders

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ChangeOrderApi.new
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get Count of changeOrders
  result = api_instance.get_procurement_changeorders_count(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->get_procurement_changeorders_count: #{e}"
end

Using the get_procurement_changeorders_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_procurement_changeorders_count_with_http_info(client_id, opts)

begin
  # Get Count of changeOrders
  data, status_code, headers = api_instance.get_procurement_changeorders_count_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->get_procurement_changeorders_count_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

Count

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2025.1

patch_procurement_changeorder_by_id

patch_procurement_changeorder_by_id(id, client_id, patch_operation)

Patch ChangeOrder

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ChangeOrderApi.new
id = 56 # Integer | ChangeOrderId
client_id = 'client_id_example' # String | 
patch_operation = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | List of PatchOperation

begin
  # Patch ChangeOrder
  result = api_instance.patch_procurement_changeorder_by_id(id, client_id, patch_operation)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->patch_procurement_changeorder_by_id: #{e}"
end

Using the patch_procurement_changeorder_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_procurement_changeorder_by_id_with_http_info(id, client_id, patch_operation)

begin
  # Patch ChangeOrder
  data, status_code, headers = api_instance.patch_procurement_changeorder_by_id_with_http_info(id, client_id, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChangeOrder>
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->patch_procurement_changeorder_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer ChangeOrderId
client_id String
patch_operation Array<PatchOperation> List of PatchOperation

Return type

ChangeOrder

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.connectwise.com+json; version=2025.1

post_procurement_changeorder

post_procurement_changeorder(client_id, change_order)

Post ChangeOrder

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ChangeOrderApi.new
client_id = 'client_id_example' # String | 
change_order = ConnectWise::ChangeOrder.new({purchase_header_rec_id: 37}) # ChangeOrder | changeOrder

begin
  # Post ChangeOrder
  result = api_instance.post_procurement_changeorder(client_id, change_order)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->post_procurement_changeorder: #{e}"
end

Using the post_procurement_changeorder_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_procurement_changeorder_with_http_info(client_id, change_order)

begin
  # Post ChangeOrder
  data, status_code, headers = api_instance.post_procurement_changeorder_with_http_info(client_id, change_order)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChangeOrder>
rescue ConnectWise::ApiError => e
  puts "Error when calling ChangeOrderApi->post_procurement_changeorder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String
change_order ChangeOrder changeOrder

Return type

ChangeOrder

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.connectwise.com+json; version=2025.1