DearInventoryRuby::InventoryApi

All URIs are relative to https://inventory.dearsystems.com/ExternalApi/v2

Method	HTTP request	Description
create_account	POST /ref/account	Allows you to create an Account
create_customer	POST /customer	Allows you to create a customer
create_payment_term	POST /ref/paymentterm	Allows you to create a payment term
create_sale_invoice	POST /sale/invoice	Allows you to create a sale invoice
create_sale_order	POST /sale/order	Allows you to create a Sale Order
create_sale_payment	POST /sale/payment	Allows you to create a Sale Payment
create_sale_quote	POST /sale/quote	Allows you to create a Sale Quote
create_tax	POST /ref/tax	Allows you to create a tax
create_webhook	POST /webhooks	Allows you to create a Webhook
delete_account	DELETE /ref/account	Allows you to delete an Account
delete_payment_term	DELETE /ref/paymentterm	Allows you to delete a payment term
delete_sale_invoice	DELETE /sale/invoice	Allows you to delete a sale invoice
delete_sale_payment	DELETE /sale/payment	Allows you to delete a sale payment
delete_webhook	DELETE /webhooks	Allows you to delete a webhook
get_accounts	GET /ref/account	Allows you to retrieve the Chart of Accounts
get_carriers	GET /ref/carrier	Allows you to retrieve the carriers
get_customers	GET /customer	Allows you to retrieve the customers
get_locations	GET /ref/location	Allows you to retrieve the locations
get_me	GET /me	Allows you to retrieve your information
get_me_contacts	GET /me/contacts	Allows you to retrieve the me contacts (Sales Representatives)
get_payment_terms	GET /ref/paymentterm	Allows you to retrieve the payment terms
get_price_tiers	GET /ref/priceTier	Allows you to retrieve the Price Tiers
get_sale	GET /sale	Allows you to retrieve the Sale
get_sale_invoices	GET /sale/invoice	Allows you to retrieve the sale invoices
get_sale_list	GET /saleList	Allows you to retrieve the Sales based on conditions
get_sale_order	GET /sale/order	Allows you to retrieve the Sale Order
get_sale_payment	GET /sale/payment	Allows you to retrieve the Sale Payments
get_sale_quote	GET /sale/quote	Allows you to retrieve the Sale Quote
get_taxes	GET /ref/tax	Allows you to retrieve the taxes
get_webhooks	GET /webhooks	Allows you to retrieve the Webhooks
update_account	PUT /ref/account	Allows you to update an Account
update_customer	PUT /customer	Allows you to update a customer
update_payment_term	PUT /ref/paymentterm	Allows you to update a payment term
update_sale_payment	PUT /sale/payment	Allows you to update a sale payment
update_tax	PUT /ref/tax	Allows you to update a tax
update_webhook	PUT /webhooks	Allows you to update a webhook

create_account

Accounts create_account(account, opts)

Allows you to create an Account

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
account = { "Code": "001", "Status": "ACTIVE", "Name": "Accounts Payable test", "Type": "CURRLIAB", "Description": "Outstanding invoices the company has received from suppliers but has not yet paid at balance date", "Class": "LIABILITY", "SystemAccount": "CREDITORS", } # Account | an Account object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create an Account
  result = api_instance.create_account(account, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_account: #{e}"
end

Parameters

Name	Type	Description	Notes
account	Account	an Account object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Accounts

Authorization

accountID, appKey

HTTP request headers

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

create_customer

Customers create_customer(customer, opts)

Allows you to create a customer

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
customer = { "Name": "DIISR - Small Business Services customer", "Currency": "AUD", "PaymentTerm": "30 days", "Discount": 0, "TaxRule": "GST Free Exports", "Carrier": "DEFAULT Carrier", "SalesRepresentative": nil, "Location": "Main Warehouse", "Comments": nil, "AccountReceivable": "610", "RevenueAccount": "200", "PriceTier": "Tier 1", "TaxNumber": nil, "AdditionalAttribute1": nil, "AdditionalAttribute2": nil, "AdditionalAttribute3": nil, "AdditionalAttribute4": nil, "AdditionalAttribute5": nil, "AdditionalAttribute6": nil, "AdditionalAttribute7": nil, "AdditionalAttribute8": nil, "AdditionalAttribute9": nil, "AdditionalAttribute10": nil, "AttributeSet": nil, "Tags": nil, "Status": "Active", "Addresses": [ { "ID": "4bc4e423-d8af-454d-a186-4a827c15bd0b", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Line1": "L3, Southbank House", "Line2": "13 Gallery Ave", "City": "Melbourne", "State": "VIC", "Postcode": "3131", "Country": nil, "Type": "Business", "DefaultForType": true }, { "ID": "35cec087-04da-46b5-b3c8-c3a7311f2417", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Line1": "L3, Southbank House", "Line2": "13 Gallery Ave", "City": "Melbourne", "State": "VIC", "Postcode": "3131", "Country": nil, "Type": "Billing", "DefaultForType": true } ], "Contacts": [ { "ID": "1d62f59b-657d-423f-ad95-9ad9ec4f29a3", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Name": "Sheree Bond", "JobTitle": nil, "Phone": "0800 4389376", "MobilePhone": nil, "Fax": "03 4389379", "Email": "accounts@diisr.govt", "Website": nil, "Default": true, "Comment": nil, "IncludeInEmail": false } ] } # Customer | a customer object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a customer
  result = api_instance.create_customer(customer, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_customer: #{e}"
end

Parameters

Name	Type	Description	Notes
customer	Customer	a customer object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Customers

Authorization

accountID, appKey

HTTP request headers

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

create_payment_term

PaymentTerms create_payment_term(payment_term, opts)

Allows you to create a payment term

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
payment_term = { "Name": "5 days since end of month", "Duration": 5, "Method": "days since the end of the month", "IsActive": true, "IsDefault": false } # PaymentTerm | a payment term object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a payment term
  result = api_instance.create_payment_term(payment_term, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_payment_term: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_term	PaymentTerm	a payment term object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

PaymentTerms

Authorization

accountID, appKey

HTTP request headers

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

create_sale_invoice

SaleInvoices create_sale_invoice(sale_invoice_post, opts)

Allows you to create a sale invoice

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
sale_invoice_post = { "SaleID": "916ab4c0-6ccb-4c93-873d-0603859050e4", "TaskID": "b039f19e-66f8-4309-a4b1-abf928303c88", "CombineAdditionalCharges": false, "Memo": "", "Status": "DRAFT", "InvoiceDate": "2017-11-22T00:00:00Z", "InvoiceDueDate": "2017-12-22T00:00:00Z", "CurrencyConversionRate": 1, "BillingAddressLine1": "3 Park Street Industrial Village Southbank", "BillingAddressLine2": "Melbourne VIC 3331", "LinkedFulfillmentNumber": "1", "Lines": [ { "ProductID": "4aadd8f6-4d3d-46ca-acbb-1a9a662f9bc1", "SKU": "Bread", "Name": "Baked Bread", "Quantity": 1, "Price": 8, "Discount": 0, "Tax": 0, "Total": 8, "AverageCost": 5, "TaxRule": "Tax on Sales", "Account": "200", "Comment": "" } ], "AdditionalCharges": [ { "Description": "Desktop/network support via phone. Per month fixed fee for minimum 20 hours/month.", "Quantity": 1, "Price": 350, "Discount": 0, "Tax": 0, "Total": 350, "TaxRule": "Tax on Sales", "Account": "200", "Comment": "" } ] } # SaleInvoicePost | a Sale Invoice object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a sale invoice
  result = api_instance.create_sale_invoice(sale_invoice_post, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_sale_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_invoice_post	SaleInvoicePost	a Sale Invoice object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

SaleInvoices

Authorization

accountID, appKey

HTTP request headers

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

create_sale_order

SaleOrder create_sale_order(sale_order, opts)

Allows you to create a Sale Order

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
sale_order = { "SaleID": "916ab4c0-6ccb-4c93-873d-0603859050e4", "Memo": "", "Status": "DRAFT", "AutoPickPackShipMode": "NOPICK", "Lines": [ { "ProductID": "4aadd8f6-4d3d-46ca-acbb-1a9a662f9bc1", "SKU": "Bread", "Name": "Baked Bread", "Quantity": 1, "Price": 8, "Discount": 0, "Tax": 0, "AverageCost": 5, "TaxRule": "Tax on Sales", "Comment": "", "DropShip": false, "BackorderQuantity": 0, "Total": 8 } ], "AdditionalCharges": [ { "Description": "Desktop/network support via phone. Per month fixed fee for minimum 20 hours/month.", "Price": 350, "Quantity": 1, "Discount": 0, "Tax": 0, "Total": 350, "TaxRule": "Tax on Sales", "Comment": "" } ], "TotalBeforeTax": 358, "Tax": 0, "Total": 358 } # SaleOrder | a Sale Order object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a Sale Order
  result = api_instance.create_sale_order(sale_order, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_sale_order: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_order	SaleOrder	a Sale Order object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

SaleOrder

Authorization

accountID, appKey

HTTP request headers

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

create_sale_payment

SalePayment create_sale_payment(sale_payment, opts)

Allows you to create a Sale Payment

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
sale_payment = { "TaskID": "4733ba69-21c5-48f5-95e5-307aa9889747", "Type": "Payment", "Reference": "", "Amount": 1, "DatePaid": "2017-11-30T00:00:00Z", "Account": "718", "CurrencyRate": 1 } # SalePayment | a Sale Payment object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a Sale Payment
  result = api_instance.create_sale_payment(sale_payment, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_sale_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_payment	SalePayment	a Sale Payment object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

SalePayment

Authorization

accountID, appKey

HTTP request headers

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

create_sale_quote

SaleQuote create_sale_quote(sale_quote, opts)

Allows you to create a Sale Quote

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
sale_quote = { "SaleID": "916ab4c0-6ccb-4c93-873d-0603859050e4", "CombineAdditionalCharges": false, "Memo": "", "Status": "AUTHORISED", "Prepayments": [], "Lines": [ { "ProductID": "4aadd8f6-4d3d-46ca-acbb-1a9a662f9bc1", "SKU": "Bread", "Name": "Baked Bread", "Quantity": 1, "Price": 8, "Discount": 0, "Tax": 0, "AverageCost": 5, "TaxRule": "Tax on Sales", "Comment": "", "Total": 8 } ], "AdditionalCharges": [ { "Description": "Desktop/network support via phone. Per month fixed fee for minimum 20 hours/month.", "Price": 350, "Quantity": 1, "Discount": 0, "Tax": 0, "Total": 350, "TaxRule": "Tax on Sales", "Comment": "" } ] } # SaleQuote | a Sale Quote object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a Sale Quote
  result = api_instance.create_sale_quote(sale_quote, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_sale_quote: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_quote	SaleQuote	a Sale Quote object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

SaleQuote

Authorization

accountID, appKey

HTTP request headers

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

create_tax

Taxes create_tax(tax, opts)

Allows you to create a tax

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
tax = { "Name": "Post test", "Account": "800", "IsActive": true, "TaxInclusive": false, "TaxPercent": 35, "IsTaxForSale": true, "IsTaxForPurchase": true, "Components": [ { "Name": "Tax 1st", "Percent": "10.0000000000", "AccountCode": "800", "Compound": "1", "ComponentOrder": "1" }, { "Name": "Tax 2nd", "Percent": "15.0000000000", "AccountCode": "800", "Compound": "0", "ComponentOrder": "2" } ] } # Tax | a tax object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a tax
  result = api_instance.create_tax(tax, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_tax: #{e}"
end

Parameters

Name	Type	Description	Notes
tax	Tax	a tax object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Taxes

Authorization

accountID, appKey

HTTP request headers

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

create_webhook

Webhook create_webhook(webhook, opts)

Allows you to create a Webhook

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
webhook = { "Type": "Sale/OrderAuthorised", "IsActive": true, "ExternalURL": "https://hookb.in/Zn8950P7", "ExternalAuthorizationType": "basicauth", "ExternalUserName": "Hello", "ExternalPassword": "123", "ExternalBearerToken": "", "ExternalHeaders": [ { "Key": "Key", "Value": "123" }, { "Key": "6", "Value": "0" } ] } # Webhook | a webhook object with properties to create
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to create a Webhook
  result = api_instance.create_webhook(webhook, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->create_webhook: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook	Webhook	a webhook object with properties to create
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Webhook

Authorization

accountID, appKey

HTTP request headers

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

delete_account

Success delete_account(opts)

Allows you to delete an Account

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  code: 'code_example' # String | Default is nil
}

begin
  #Allows you to delete an Account
  result = api_instance.delete_account(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->delete_account: #{e}"
end

Parameters

Name	Type	Description	Notes
code	String	Default is nil	[optional]

Return type

Success

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_payment_term

Success delete_payment_term(opts)

Allows you to delete a payment term

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  id: 'id_example' # String | Default is nil
}

begin
  #Allows you to delete a payment term
  result = api_instance.delete_payment_term(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->delete_payment_term: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Default is nil	[optional]

Return type

Success

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_sale_invoice

SaleInvoices delete_sale_invoice(opts)

Allows you to delete a sale invoice

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  task_id: 'task_id_example', # String | ID of Sale task to Void or Undo
  void: false # Boolean | Default is false
}

begin
  #Allows you to delete a sale invoice
  result = api_instance.delete_sale_invoice(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->delete_sale_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
task_id	String	ID of Sale task to Void or Undo	[optional]
void	Boolean	Default is false	[optional] [default to false]

Return type

SaleInvoices

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_sale_payment

Success delete_sale_payment(opts)

Allows you to delete a sale payment

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  id: 'id_example' # String | Default is nil
}

begin
  #Allows you to delete a sale payment
  result = api_instance.delete_sale_payment(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->delete_sale_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Default is nil	[optional]

Return type

Success

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_webhook

Webhooks delete_webhook(opts)

Allows you to delete a webhook

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  id: 'id_example' # String | Default is nil
}

begin
  #Allows you to delete a webhook
  result = api_instance.delete_webhook(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->delete_webhook: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Default is nil	[optional]

Return type

Webhooks

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_accounts

Accounts get_accounts(opts)

Allows you to retrieve the Chart of Accounts

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  code: 'code_example', # String | Default is nil
  name: 'name_example', # String | Default is nil
  _class: '_class_example', # String | Default is nil
  type: 'type_example', # String | Default is nil
  status: 'status_example' # String | Default is nil
}

begin
  #Allows you to retrieve the Chart of Accounts
  result = api_instance.get_accounts(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_accounts: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
code	String	Default is nil	[optional]
name	String	Default is nil	[optional]
_class	String	Default is nil	[optional]
type	String	Default is nil	[optional]
status	String	Default is nil	[optional]

Return type

Accounts

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_carriers

Carriers get_carriers(opts)

Allows you to retrieve the carriers

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  carrier_id: 'carrier_id_example', # String | Only return Carrier with the specific CarrierID
  description: 'description_example' # String | Only return Carriers that start with the specific Description
}

begin
  #Allows you to retrieve the carriers
  result = api_instance.get_carriers(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_carriers: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
carrier_id	String	Only return Carrier with the specific CarrierID	[optional]
description	String	Only return Carriers that start with the specific Description	[optional]

Return type

Carriers

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_customers

Customers get_customers(opts)

Allows you to retrieve the customers

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  id: 'id_example', # String | Default is nil
  name: 'name_example', # String | Default is nil
  contact_filter: 'contact_filter_example', # String | Default is nil
  modified_since: 'modified_since_example', # String | Default is nil
  include_deprecated: false, # Boolean | Default is false
  include_product_prices: false # Boolean | Default is false
}

begin
  #Allows you to retrieve the customers
  result = api_instance.get_customers(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_customers: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
id	String	Default is nil	[optional]
name	String	Default is nil	[optional]
contact_filter	String	Default is nil	[optional]
modified_since	String	Default is nil	[optional]
include_deprecated	Boolean	Default is false	[optional] [default to false]
include_product_prices	Boolean	Default is false	[optional] [default to false]

Return type

Customers

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_locations

Locations get_locations(opts)

Allows you to retrieve the locations

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  id: 'id_example', # String | Default is nil
  deprecated: false, # Boolean | Default is false
  name: 'name_example' # String | Default is nil
}

begin
  #Allows you to retrieve the locations
  result = api_instance.get_locations(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_locations: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
id	String	Default is nil	[optional]
deprecated	Boolean	Default is false	[optional] [default to false]
name	String	Default is nil	[optional]

Return type

Locations

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_me

Me get_me

Allows you to retrieve your information

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new

begin
  #Allows you to retrieve your information
  result = api_instance.get_me
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_me: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Me

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_me_contacts

MeContacts get_me_contacts

Allows you to retrieve the me contacts (Sales Representatives)

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new

begin
  #Allows you to retrieve the me contacts (Sales Representatives)
  result = api_instance.get_me_contacts
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_me_contacts: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

MeContacts

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_payment_terms

PaymentTerms get_payment_terms(opts)

Allows you to retrieve the payment terms

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  id: 'id_example', # String | Default is nil
  name: 'name_example', # String | Default is nil
  method: 'method_example', # String | Default is nil
  is_active: true, # Boolean | Default is nil
  is_default: true # Boolean | Default is nil
}

begin
  #Allows you to retrieve the payment terms
  result = api_instance.get_payment_terms(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_payment_terms: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
id	String	Default is nil	[optional]
name	String	Default is nil	[optional]
method	String	Default is nil	[optional]
is_active	Boolean	Default is nil	[optional]
is_default	Boolean	Default is nil	[optional]

Return type

PaymentTerms

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_price_tiers

PriceTiers get_price_tiers

Allows you to retrieve the Price Tiers

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new

begin
  #Allows you to retrieve the Price Tiers
  result = api_instance.get_price_tiers
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_price_tiers: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

PriceTiers

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_sale

Sale get_sale(opts)

Allows you to retrieve the Sale

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  id: 'id_example', # String | Default is nil
  combine_additional_charges: false, # Boolean | Show additional charges in 'Lines' array
  hide_inventory_movements: false, # Boolean | Hide inventory movements (Default = false)
  include_transactions: false # Boolean | Show related transactions (Default = false)
}

begin
  #Allows you to retrieve the Sale
  result = api_instance.get_sale(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_sale: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Default is nil	[optional]
combine_additional_charges	Boolean	Show additional charges in 'Lines' array	[optional] [default to false]
hide_inventory_movements	Boolean	Hide inventory movements (Default = false)	[optional] [default to false]
include_transactions	Boolean	Show related transactions (Default = false)	[optional] [default to false]

Return type

Sale

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_sale_invoices

SaleInvoices get_sale_invoices(opts)

Allows you to retrieve the sale invoices

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  sale_id: 'sale_id_example', # String | Unique DEAR Sale ID
  combine_additional_charges: false, # Boolean | Show additional charges in 'Lines' array
  include_product_info: false # Boolean | Show all used products in additional array
}

begin
  #Allows you to retrieve the sale invoices
  result = api_instance.get_sale_invoices(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_sale_invoices: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_id	String	Unique DEAR Sale ID	[optional]
combine_additional_charges	Boolean	Show additional charges in 'Lines' array	[optional] [default to false]
include_product_info	Boolean	Show all used products in additional array	[optional] [default to false]

Return type

SaleInvoices

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_sale_list

SaleList get_sale_list(opts)

Allows you to retrieve the Sales based on conditions

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  search: 'search_example', # String | Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber
  created_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales created after specified date. Date must follow ISO 8601 format.
  updated_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales changed after specified date. Date must follow ISO 8601 format.
  ship_by: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.
  quote_status: 'quote_status_example', # String | Only return sales with specified quote status
  order_status: 'order_status_example', # String | Only return sales with specified order status
  combined_pick_status: 'combined_pick_status_example', # String | Only return sales with specified CombinedPickingStatus
  combined_pack_status: 'combined_pack_status_example', # String | Only return sales with specified CombinedPackingStatus
  combined_shipping_status: 'combined_shipping_status_example', # String | Only return sales with specified CombinedShippingStatus
  combined_invoice_status: 'combined_invoice_status_example', # String | Only return sales with specified CombinedInvoiceStatus
  credit_note_status: 'credit_note_status_example', # String | Only return sales with specified credit note status
  external_id: 'external_id_example', # String | Only return sales with specified External ID
  status: 'status_example', # String | Default is nil
  ready_for_shipping: true, # Boolean | Only return sales with 'Authorised' pack and not 'Authorised' shipping
  order_location_id: 'order_location_id_example' # String | Only return sales with specified Order Location ID
}

begin
  #Allows you to retrieve the Sales based on conditions
  result = api_instance.get_sale_list(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_sale_list: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
search	String	Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber	[optional]
created_since	DateTime	Only return sales created after specified date. Date must follow ISO 8601 format.	[optional]
updated_since	DateTime	Only return sales changed after specified date. Date must follow ISO 8601 format.	[optional]
ship_by	DateTime	Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.	[optional]
quote_status	String	Only return sales with specified quote status	[optional]
order_status	String	Only return sales with specified order status	[optional]
combined_pick_status	String	Only return sales with specified CombinedPickingStatus	[optional]
combined_pack_status	String	Only return sales with specified CombinedPackingStatus	[optional]
combined_shipping_status	String	Only return sales with specified CombinedShippingStatus	[optional]
combined_invoice_status	String	Only return sales with specified CombinedInvoiceStatus	[optional]
credit_note_status	String	Only return sales with specified credit note status	[optional]
external_id	String	Only return sales with specified External ID	[optional]
status	String	Default is nil	[optional]
ready_for_shipping	Boolean	Only return sales with 'Authorised' pack and not 'Authorised' shipping	[optional]
order_location_id	String	Only return sales with specified Order Location ID	[optional]

Return type

SaleList

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_sale_order

SaleOrder get_sale_order(opts)

Allows you to retrieve the Sale Order

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  sale_id: 'sale_id_example', # String | Unique DEAR Sale ID
  combine_additional_charges: false, # Boolean | Show additional charges in 'Lines' array
  include_product_info: false # Boolean | Show all used products in additional array
}

begin
  #Allows you to retrieve the Sale Order
  result = api_instance.get_sale_order(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_sale_order: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_id	String	Unique DEAR Sale ID	[optional]
combine_additional_charges	Boolean	Show additional charges in 'Lines' array	[optional] [default to false]
include_product_info	Boolean	Show all used products in additional array	[optional] [default to false]

Return type

SaleOrder

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_sale_payment

Array<SalePayment> get_sale_payment(opts)

Allows you to retrieve the Sale Payments

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  sale_id: 'sale_id_example' # String | Unique DEAR Sale ID
}

begin
  #Allows you to retrieve the Sale Payments
  result = api_instance.get_sale_payment(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_sale_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_id	String	Unique DEAR Sale ID	[optional]

Return type

Array<SalePayment>

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_sale_quote

SaleQuote get_sale_quote(opts)

Allows you to retrieve the Sale Quote

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  sale_id: 'sale_id_example', # String | Unique DEAR Sale ID
  combine_additional_charges: false, # Boolean | Show additional charges in 'Lines' array
  include_product_info: false # Boolean | Show all used products in additional array
}

begin
  #Allows you to retrieve the Sale Quote
  result = api_instance.get_sale_quote(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_sale_quote: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_id	String	Unique DEAR Sale ID	[optional]
combine_additional_charges	Boolean	Show additional charges in 'Lines' array	[optional] [default to false]
include_product_info	Boolean	Show all used products in additional array	[optional] [default to false]

Return type

SaleQuote

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_taxes

Taxes get_taxes(opts)

Allows you to retrieve the taxes

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
opts = {
  page: '1', # String | Default is 1
  limit: '100', # String | Default is 100
  id: 'id_example', # String | Default is nil
  name: 'name_example', # String | Default is nil
  is_active: true, # Boolean | Default is nil
  is_tax_for_sale: true, # Boolean | Default is nil
  is_tax_for_purchase: true, # Boolean | Default is nil
  account: 'account_example' # String | Default is nil
}

begin
  #Allows you to retrieve the taxes
  result = api_instance.get_taxes(opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_taxes: #{e}"
end

Parameters

Name	Type	Description	Notes
page	String	Default is 1	[optional] [default to '1']
limit	String	Default is 100	[optional] [default to '100']
id	String	Default is nil	[optional]
name	String	Default is nil	[optional]
is_active	Boolean	Default is nil	[optional]
is_tax_for_sale	Boolean	Default is nil	[optional]
is_tax_for_purchase	Boolean	Default is nil	[optional]
account	String	Default is nil	[optional]

Return type

Taxes

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_webhooks

Webhooks get_webhooks

Allows you to retrieve the Webhooks

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new

begin
  #Allows you to retrieve the Webhooks
  result = api_instance.get_webhooks
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->get_webhooks: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Webhooks

Authorization

accountID, appKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_account

Accounts update_account(account, opts)

Allows you to update an Account

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
account = { "Code": "001", "Status": "ACTIVE", "Name": "Accounts Payable put test", "Type": "CURRLIAB", "Description": "Put test description", "Class": "LIABILITY", "SystemAccount": "CREDITORS" } # Account | an Account object with properties to update
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to update an Account
  result = api_instance.update_account(account, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->update_account: #{e}"
end

Parameters

Name	Type	Description	Notes
account	Account	an Account object with properties to update
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Accounts

Authorization

accountID, appKey

HTTP request headers

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

update_customer

Customers update_customer(customer, opts)

Allows you to update a customer

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
customer = { "ID": "7d6b441a-3067-42b1-9b81-2def95df827b", "Name": "DIISR - Small Business Services customer", "Currency": "AUD", "PaymentTerm": "30 days", "Discount": 0, "TaxRule": "GST Free Exports", "Carrier": "DEFAULT Carrier", "SalesRepresentative": nil, "Location": "Main Warehouse", "Comments": nil, "AccountReceivable": "610", "RevenueAccount": "200", "PriceTier": "Tier 1", "TaxNumber": nil, "AdditionalAttribute1": nil, "AdditionalAttribute2": nil, "AdditionalAttribute3": nil, "AdditionalAttribute4": nil, "AdditionalAttribute5": nil, "AdditionalAttribute6": nil, "AdditionalAttribute7": nil, "AdditionalAttribute8": nil, "AdditionalAttribute9": nil, "AdditionalAttribute10": nil, "AttributeSet": nil, "Tags": nil, "Status": "Active", "Addresses": [ { "ID": "4bc4e423-d8af-454d-a186-4a827c15bd0b", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Line1": "L3, Southbank House", "Line2": "13 Gallery Ave", "City": "Melbourne", "State": "VIC", "Postcode": "3131", "Country": nil, "Type": "Business", "DefaultForType": true }, { "ID": "35cec087-04da-46b5-b3c8-c3a7311f2417", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Line1": "L3, Southbank House", "Line2": "13 Gallery Ave", "City": "Melbourne", "State": "VIC", "Postcode": "3131", "Country": nil, "Type": "Billing", "DefaultForType": true } ], "Contacts": [ { "ID": "1d62f59b-657d-423f-ad95-9ad9ec4f29a3", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Name": "Sheree Bond", "JobTitle": nil, "Phone": "0800 4389376", "MobilePhone": nil, "Fax": "03 4389379", "Email": "accounts@diisr.govt", "Website": nil, "Default": true, "Comment": nil, "IncludeInEmail": false } ] } # Customer | a customer object with properties to update
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to update a customer
  result = api_instance.update_customer(customer, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->update_customer: #{e}"
end

Parameters

Name	Type	Description	Notes
customer	Customer	a customer object with properties to update
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Customers

Authorization

accountID, appKey

HTTP request headers

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

update_payment_term

PaymentTerms update_payment_term(payment_term, opts)

Allows you to update a payment term

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
payment_term = { "ID": "e6c25fa9-bb14-45b2-afe7-428e454663ef", "Name": "10 days since end of month", "Duration": 10, "Method": "days since the end of the month", "IsActive": true, "IsDefault": true } # PaymentTerm | a payment term object with properties to update
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to update a payment term
  result = api_instance.update_payment_term(payment_term, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->update_payment_term: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_term	PaymentTerm	a payment term object with properties to update
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

PaymentTerms

Authorization

accountID, appKey

HTTP request headers

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

update_sale_payment

SalePayment update_sale_payment(sale_payment, opts)

Allows you to update a sale payment

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
sale_payment = { "ID": "ee093a0c-d177-9728-1df5-628a61a939e4", "Reference": "", "Amount": 357, "DatePaid": "2017-11-30T00:00:00Z", "Account": "718", "CurrencyRate": 1, } # SalePayment | a sale payment object with properties to update
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to update a sale payment
  result = api_instance.update_sale_payment(sale_payment, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->update_sale_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
sale_payment	SalePayment	a sale payment object with properties to update
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

SalePayment

Authorization

accountID, appKey

HTTP request headers

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

update_tax

Taxes update_tax(tax, opts)

Allows you to update a tax

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
tax = { "ID": "24551562-ebd1-4294-a04a-3ab258f5e541", "Name": "PUT test", "Account": "800", "IsActive": true, "TaxInclusive": false, "TaxPercent": 55, "IsTaxForSale": true, "IsTaxForPurchase": true, "Components": [ { "ID": "0119E1C0-504A-429B-B4E2-4EEC02A9E88A", "Name": "Tax 1st", "Percent": "20.0000000000", "AccountCode": "800", "Compound": "1", "ComponentOrder": "1" }, { "ID": "0B6D5C0F-D8EF-41FF-86D2-A05E5616FC61", "Name": "Tax 2nd", "Percent": "35.0000000000", "AccountCode": "800", "Compound": "0", "ComponentOrder": "2" } ] } # Tax | a tax object with properties to update
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to update a tax
  result = api_instance.update_tax(tax, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->update_tax: #{e}"
end

Parameters

Name	Type	Description	Notes
tax	Tax	a tax object with properties to update
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Taxes

Authorization

accountID, appKey

HTTP request headers

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

update_webhook

Webhook update_webhook(webhook, opts)

Allows you to update a webhook

Example

# load the gem
require 'dear-inventory-ruby'
# setup authorization
DearInventoryRuby.configure do |config|
  # Configure API key authorization: accountID
  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'

  # Configure API key authorization: appKey
  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
end

api_instance = DearInventoryRuby::InventoryApi.new
webhook = { "ID": "1cf8cb83-bf39-494b-87f9-1252b684d6d5", "Type": "Sale/OrderAuthorised", "Name": "Sale order has been authorised", "IsActive": true, "ExternalURL": "https://hookb.in/Zn8950P7", "ExternalAuthorizationType": "basicauth", "ExternalUserName": "Hello", "ExternalPassword": "123", "ExternalBearerToken": nil, "ExternalHeaders": [ { "Key": "Key", "Value": "123" }, { "Key": "6", "Value": "0" }, { "Key": "New Key", "Value": "New Value" } ] } # Webhook | a webhook object with properties to update
opts = {
  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
}

begin
  #Allows you to update a webhook
  result = api_instance.update_webhook(webhook, opts)
  p result
rescue DearInventoryRuby::ApiError => e
  puts "Exception when calling InventoryApi->update_webhook: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook	Webhook	a webhook object with properties to update
summarize_errors	Boolean	If false return 200 OK and mix of successfully created objects and any with validation errors	[optional] [default to false]

Return type

Webhook

Authorization

accountID, appKey

HTTP request headers

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

Files

InventoryApi.md

Latest commit

History

InventoryApi.md

File metadata and controls

DearInventoryRuby::InventoryApi

create_account

Example

Parameters

Return type

Authorization

HTTP request headers

create_customer

Example

Parameters

Return type

Authorization

HTTP request headers

create_payment_term

Example

Parameters

Return type

Authorization

HTTP request headers

create_sale_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

create_sale_order

Example

Parameters

Return type

Authorization

HTTP request headers

create_sale_payment

Example

Parameters

Return type

Authorization

HTTP request headers

create_sale_quote

Example

Parameters

Return type

Authorization

HTTP request headers

create_tax

Example

Parameters

Return type

Authorization

HTTP request headers

create_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

delete_account

Example

Parameters

Return type

Authorization

HTTP request headers

delete_payment_term

Example

Parameters

Return type

Authorization

HTTP request headers

delete_sale_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

delete_sale_payment