Skip to content

Latest commit

 

History

History
444 lines (288 loc) · 8.95 KB

InvoicesApi.md

File metadata and controls

444 lines (288 loc) · 8.95 KB
Raw

Connectwise::InvoicesApi

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

Method HTTP request Description
finance_invoices_count_get GET /finance/invoices/count
finance_invoices_get GET /finance/invoices
finance_invoices_id_delete DELETE /finance/invoices/{id}
finance_invoices_id_get GET /finance/invoices/{id}
finance_invoices_id_patch PATCH /finance/invoices/{id}
finance_invoices_id_pdf_get GET /finance/invoices/{id}/pdf
finance_invoices_id_put PUT /finance/invoices/{id}
finance_invoices_post POST /finance/invoices

finance_invoices_count_get

Count finance_invoices_count_get(opts)

Get Invoices 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::InvoicesApi.new

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

begin
  result = api_instance.finance_invoices_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling InvoicesApi->finance_invoices_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

finance_invoices_get

Array<Invoice> finance_invoices_get(opts)

Get Invoices

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

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

begin
  result = api_instance.finance_invoices_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling InvoicesApi->finance_invoices_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<Invoice>

Authorization

BasicAuth

HTTP request headers

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

finance_invoices_id_delete

finance_invoices_id_delete(id)

Delete Invoice 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::InvoicesApi.new

id = 56 # Integer | 


begin
  api_instance.finance_invoices_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling InvoicesApi->finance_invoices_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

finance_invoices_id_get

Invoice finance_invoices_id_get(id)

Get Invoice 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::InvoicesApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Invoice

Authorization

BasicAuth

HTTP request headers

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

finance_invoices_id_patch

Invoice finance_invoices_id_patch(id, operations)

Update Invoice

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

id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Invoice

Authorization

BasicAuth

HTTP request headers

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

finance_invoices_id_pdf_get

finance_invoices_id_pdf_get(id)

Get Invoice Pdf

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

id = 56 # Integer | 


begin
  api_instance.finance_invoices_id_pdf_get(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling InvoicesApi->finance_invoices_id_pdf_get: #{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: application/pdf

finance_invoices_id_put

Invoice finance_invoices_id_put(id, invoice)

Replace Invoice

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

id = 56 # Integer | 

invoice = Connectwise::Invoice.new # Invoice | 


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

Parameters

Name Type Description Notes
id Integer
invoice Invoice

Return type

Invoice

Authorization

BasicAuth

HTTP request headers

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

finance_invoices_post

Invoice finance_invoices_post(invoice)

Create Invoice

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

invoice = Connectwise::Invoice.new # Invoice | 


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

Parameters

Name Type Description Notes
invoice Invoice

Return type

Invoice

Authorization

BasicAuth

HTTP request headers

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