dear-inventory-ruby 0.2.11 → 0.2.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +4 -4
  4. data/docs/Account.md +15 -15
  5. data/docs/Accounts.md +3 -3
  6. data/docs/Address.md +8 -8
  7. data/docs/AttachmentLine.md +5 -5
  8. data/docs/Bin.md +2 -2
  9. data/docs/Carrier.md +2 -2
  10. data/docs/Carriers.md +3 -3
  11. data/docs/Contact.md +9 -9
  12. data/docs/Customer.md +31 -31
  13. data/docs/Customers.md +3 -3
  14. data/docs/Error.md +2 -2
  15. data/docs/ExternalHeader.md +2 -2
  16. data/docs/InventoryApi.md +64 -64
  17. data/docs/Location.md +12 -12
  18. data/docs/Locations.md +3 -3
  19. data/docs/Me.md +7 -7
  20. data/docs/MeContact.md +8 -8
  21. data/docs/MeContacts.md +3 -3
  22. data/docs/PaymentTerm.md +4 -4
  23. data/docs/PaymentTerms.md +3 -3
  24. data/docs/PriceTier.md +2 -2
  25. data/docs/PriceTiers.md +1 -1
  26. data/docs/Sale.md +43 -43
  27. data/docs/SaleAdditionalCharge.md +8 -8
  28. data/docs/SaleInvoice.md +17 -17
  29. data/docs/SaleInvoiceAdditionalCharge.md +9 -9
  30. data/docs/SaleInvoiceDelete.md +1 -1
  31. data/docs/SaleInvoiceLine.md +12 -12
  32. data/docs/SaleInvoicePartial.md +12 -12
  33. data/docs/SaleInvoicePost.md +12 -12
  34. data/docs/SaleInvoices.md +2 -2
  35. data/docs/SaleItem.md +31 -31
  36. data/docs/SaleList.md +3 -3
  37. data/docs/SaleOrder.md +9 -9
  38. data/docs/SaleOrderLine.md +13 -13
  39. data/docs/SalePayment.md +14 -14
  40. data/docs/SalePaymentLine.md +7 -7
  41. data/docs/SaleQuote.md +8 -8
  42. data/docs/SaleQuoteLine.md +11 -11
  43. data/docs/ShippingAddress.md +11 -11
  44. data/docs/Success.md +1 -1
  45. data/docs/SupplierCustomerAddress.md +9 -9
  46. data/docs/Tax.md +5 -5
  47. data/docs/TaxComponent.md +3 -3
  48. data/docs/Taxes.md +3 -3
  49. data/docs/Webhook.md +10 -10
  50. data/docs/Webhooks.md +1 -1
  51. data/lib/dear-inventory-ruby/models/supplier_customer_address.rb +7 -7
  52. data/lib/dear-inventory-ruby/version.rb +1 -1
  53. data/spec/.DS_Store +0 -0
  54. data/spec/models/supplier_customer_address_spec.rb +1 -1
  55. metadata +3 -7
data/docs/SaleInvoice.md CHANGED
@@ -4,23 +4,23 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **task_id** | **String** | Identifier of sale Invoice task |
8
- **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
9
- **memo** | **String** | Additional information for Invoice. | [optional]
10
- **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
11
- **invoice_date** | **String** | Invoice Date. |
12
- **invoice_due_date** | **String** | Invoice Due Date. |
13
- **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
14
- **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
15
- **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
16
- **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
17
- **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
18
- **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
19
- **payments** | [**Array<SalePaymentLine>**](SalePaymentLine.md) | | [optional]
20
- **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges without taxes. | [optional]
21
- **tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges taxes. | [optional]
22
- **total** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges with taxes. | [optional]
23
- **paid** | **Float** | Decimal with up to 4 decimal places. Sum of payments. | [optional]
7
+ **task_id** | **String** | Identifier of sale Invoice task |
8
+ **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
9
+ **memo** | **String** | Additional information for Invoice. | [optional]
10
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
11
+ **invoice_date** | **String** | Invoice Date. |
12
+ **invoice_due_date** | **String** | Invoice Due Date. |
13
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
14
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
15
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
16
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
17
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
18
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
19
+ **payments** | [**Array<SalePaymentLine>**](SalePaymentLine.md) | | [optional]
20
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges without taxes. | [optional]
21
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges taxes. | [optional]
22
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges with taxes. | [optional]
23
+ **paid** | **Float** | Decimal with up to 4 decimal places. Sum of payments. | [optional]
24
24
 
25
25
  ## Code Sample
26
26
 
data/docs/SaleInvoiceAdditionalCharge.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **description** | **String** | Name of Service Product referenced by this Line |
8
- **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
9
- **price** | **Float** | Price per unit in Customer currency |
10
- **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
11
- **tax** | **Float** | Tax |
12
- **total** | **Float** | Line Total.For validation | [optional]
13
- **tax_rule** | **String** | Line Tax Rule name. |
14
- **account** | **String** | Revenue account |
15
- **comment** | **String** | Comment | [optional]
7
+ **description** | **String** | Name of Service Product referenced by this Line |
8
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
9
+ **price** | **Float** | Price per unit in Customer currency |
10
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
11
+ **tax** | **Float** | Tax |
12
+ **total** | **Float** | Line Total.For validation | [optional]
13
+ **tax_rule** | **String** | Line Tax Rule name. |
14
+ **account** | **String** | Revenue account |
15
+ **comment** | **String** | Comment | [optional]
16
16
 
17
17
  ## Code Sample
18
18
 
data/docs/SaleInvoiceDelete.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **task_id** | **String** | ID of Sale task to Void or Undo |
7
+ **task_id** | **String** | ID of Sale task to Void or Undo |
8
8
  **void** | **Boolean** | Default false | [optional] [default to false]
9
9
 
10
10
  ## Code Sample
data/docs/SaleInvoiceLine.md CHANGED
@@ -4,18 +4,18 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
- **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
- **name** | **String** | Product Name referenced by this Line |
10
- **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
- **price** | **Float** | Price per unit in Customer currency |
12
- **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
- **tax** | **Float** | Tax | [optional]
14
- **total** | **Float** | Line Total. For validation | [optional]
15
- **average_cost** | **Float** | Average product cost | [optional]
16
- **tax_rule** | **String** | Line Tax Rule name. | [optional]
17
- **account** | **String** | Revenue account | [optional]
18
- **comment** | **String** | Comment for this line | [optional]
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
+ **name** | **String** | Product Name referenced by this Line |
10
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
+ **price** | **Float** | Price per unit in Customer currency |
12
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
+ **tax** | **Float** | Tax | [optional]
14
+ **total** | **Float** | Line Total. For validation | [optional]
15
+ **average_cost** | **Float** | Average product cost | [optional]
16
+ **tax_rule** | **String** | Line Tax Rule name. | [optional]
17
+ **account** | **String** | Revenue account | [optional]
18
+ **comment** | **String** | Comment for this line | [optional]
19
19
 
20
20
  ## Code Sample
21
21
 
data/docs/SaleInvoicePartial.md CHANGED
@@ -4,19 +4,19 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **task_id** | **String** | Identifier of sale Invoice task |
7
+ **task_id** | **String** | Identifier of sale Invoice task |
8
8
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [optional] [default to false]
9
- **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
10
- **memo** | **String** | Additional information for Invoice. | [optional]
11
- **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
- **invoice_date** | **String** | Invoice Date. |
13
- **invoice_due_date** | **String** | Invoice Due Date. |
14
- **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
- **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
- **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
- **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
- **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
- **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
9
+ **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
10
+ **memo** | **String** | Additional information for Invoice. | [optional]
11
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
+ **invoice_date** | **String** | Invoice Date. |
13
+ **invoice_due_date** | **String** | Invoice Due Date. |
14
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
data/docs/SaleInvoicePost.md CHANGED
@@ -4,19 +4,19 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
8
- **task_id** | **String** | Identifier of sale Invoice task |
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **task_id** | **String** | Identifier of sale Invoice task |
9
9
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
10
- **memo** | **String** | Additional information for Invoice. | [optional]
11
- **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
- **invoice_date** | **String** | Invoice Date. |
13
- **invoice_due_date** | **String** | Invoice Due Date. |
14
- **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
- **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
- **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
- **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
- **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
- **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
10
+ **memo** | **String** | Additional information for Invoice. | [optional]
11
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
+ **invoice_date** | **String** | Invoice Date. |
13
+ **invoice_due_date** | **String** | Invoice Due Date. |
14
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
data/docs/SaleInvoices.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
8
- **invoices** | [**Array<SaleInvoicePartial>**](SaleInvoicePartial.md) | Array of Invoices | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **invoices** | [**Array<SaleInvoicePartial>**](SaleInvoicePartial.md) | Array of Invoices | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
data/docs/SaleItem.md CHANGED
@@ -4,37 +4,37 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale identifier | [optional]
8
- **order_number** | **String** | Sale Order number generated by DEAR | [optional]
9
- **status** | **String** | Current sale status. Possible values are values | [optional]
10
- **order_date** | **Date** | Date when Sale Order was created | [optional]
11
- **invoice_date** | **Date** | Date when Invoice was issued | [optional]
12
- **customer** | **String** | Name of the customer | [optional]
13
- **customer_id** | **String** | Customer Identifier | [optional]
14
- **invoice_number** | **String** | Invoice number generated by DEAR | [optional]
15
- **customer_reference** | **String** | Optional Customer Reference (typically customer Purchase order number) supplied by the customer for the sale | [optional]
16
- **invoice_amount** | **Float** | Total Invoice amount minus total Credit note amount in customer currency | [optional]
17
- **paid_amount** | **Float** | Total Paid amount minus Refunded amount in customer currency | [optional]
18
- **invoice_due_date** | **Date** | Date when invoice is due according to selected payment terms | [optional]
19
- **ship_by** | **Date** | Date when shipment is due | [optional]
20
- **base_currency** | **String** | 3 digit Base currency code (as configured in General Settings) | [optional]
21
- **customer_currency** | **String** | 3 digit Customer currency code | [optional]
22
- **credit_note_number** | **String** | Credit note number generated by DEAR. Is empty unless credit note is created | [optional]
23
- **updated** | **Date** | Date when the sale was last created/updated last time | [optional]
24
- **quote_status** | **String** | Sale Quote status. Possible Values are values | [optional]
25
- **order_status** | **String** | Sale Order status. Possible Values are values | [optional]
26
- **combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional]
27
- **combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional]
28
- **combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional]
29
- **ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional]
30
- **combined_invoice_status** | **String** | Invoice status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE, PAID | [optional]
31
- **credit_note_status** | **String** | Credit Note status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE | [optional]
32
- **combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional]
33
- **type** | **String** | Type of Sale. Possible Values are Simple Sale, Advanced Sale , Service Sale | [optional]
34
- **combined_tracking_numbers** | **String** | Tracking Numbers | [optional]
35
- **source_channel** | **String** | Source of the sale. read-only field | [optional]
36
- **external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional]
37
- **order_location_id** | **String** | Sale Order Location ID | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale identifier | [optional]
8
+ **order_number** | **String** | Sale Order number generated by DEAR | [optional]
9
+ **status** | **String** | Current sale status. Possible values are values | [optional]
10
+ **order_date** | **Date** | Date when Sale Order was created | [optional]
11
+ **invoice_date** | **Date** | Date when Invoice was issued | [optional]
12
+ **customer** | **String** | Name of the customer | [optional]
13
+ **customer_id** | **String** | Customer Identifier | [optional]
14
+ **invoice_number** | **String** | Invoice number generated by DEAR | [optional]
15
+ **customer_reference** | **String** | Optional Customer Reference (typically customer Purchase order number) supplied by the customer for the sale | [optional]
16
+ **invoice_amount** | **Float** | Total Invoice amount minus total Credit note amount in customer currency | [optional]
17
+ **paid_amount** | **Float** | Total Paid amount minus Refunded amount in customer currency | [optional]
18
+ **invoice_due_date** | **Date** | Date when invoice is due according to selected payment terms | [optional]
19
+ **ship_by** | **Date** | Date when shipment is due | [optional]
20
+ **base_currency** | **String** | 3 digit Base currency code (as configured in General Settings) | [optional]
21
+ **customer_currency** | **String** | 3 digit Customer currency code | [optional]
22
+ **credit_note_number** | **String** | Credit note number generated by DEAR. Is empty unless credit note is created | [optional]
23
+ **updated** | **Date** | Date when the sale was last created/updated last time | [optional]
24
+ **quote_status** | **String** | Sale Quote status. Possible Values are values | [optional]
25
+ **order_status** | **String** | Sale Order status. Possible Values are values | [optional]
26
+ **combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional]
27
+ **combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional]
28
+ **combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional]
29
+ **ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional]
30
+ **combined_invoice_status** | **String** | Invoice status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE, PAID | [optional]
31
+ **credit_note_status** | **String** | Credit Note status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE | [optional]
32
+ **combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional]
33
+ **type** | **String** | Type of Sale. Possible Values are Simple Sale, Advanced Sale , Service Sale | [optional]
34
+ **combined_tracking_numbers** | **String** | Tracking Numbers | [optional]
35
+ **source_channel** | **String** | Source of the sale. read-only field | [optional]
36
+ **external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional]
37
+ **order_location_id** | **String** | Sale Order Location ID | [optional]
38
38
 
39
39
  ## Code Sample
40
40
 
data/docs/SaleList.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total** | **Float** | Total | [optional]
8
- **page** | **Float** | Page | [optional]
9
- **sale_list** | [**Array<SaleItem>**](SaleItem.md) | Array of SaleItem | [optional]
7
+ **total** | **Float** | Total | [optional]
8
+ **page** | **Float** | Page | [optional]
9
+ **sale_list** | [**Array<SaleItem>**](SaleItem.md) | Array of SaleItem | [optional]
10
10
 
11
11
  ## Code Sample
12
12
 
data/docs/SaleOrder.md CHANGED
@@ -4,16 +4,16 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
8
- **sale_order_number** | **String** | Sale Order Number (auto-generated) | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **sale_order_number** | **String** | Sale Order Number (auto-generated) | [optional]
9
9
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
10
- **memo** | **String** | Additional information for Order. |
11
- **status** | **String** | Order Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
12
- **lines** | [**Array<SaleOrderLine>**](SaleOrderLine.md) | | [optional]
13
- **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
14
- **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges without taxes. Not required for POST. |
15
- **tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges taxes. Not required for POST. |
16
- **total** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges with taxes. Not required for POST. |
10
+ **memo** | **String** | Additional information for Order. |
11
+ **status** | **String** | Order Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
12
+ **lines** | [**Array<SaleOrderLine>**](SaleOrderLine.md) | | [optional]
13
+ **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
14
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges without taxes. Not required for POST. |
15
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges taxes. Not required for POST. |
16
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges with taxes. Not required for POST. |
17
17
 
18
18
  ## Code Sample
19
19
 
data/docs/SaleOrderLine.md CHANGED
@@ -4,19 +4,19 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
- **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
- **name** | **String** | Product Name referenced by this Line |
10
- **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
- **price** | **Float** | Price per unit in Customer currency |
12
- **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
- **tax** | **Float** | Tax | [optional]
14
- **average_cost** | **Float** | Average product cost | [optional]
15
- **tax_rule** | **String** | Line Tax Rule name. | [optional]
16
- **comment** | **String** | Comment for this line | [optional]
17
- **drop_ship** | **Boolean** | Required if product is not a service with “Optional Drop Ship” mode. Otherwise it ignored. | [optional]
18
- **backorder_quantity** | **Float** | Quantity of the ordered product on backorder. Read Only for POST | [optional]
19
- **total** | **Float** | Line Total. For validation | [optional]
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
+ **name** | **String** | Product Name referenced by this Line |
10
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
+ **price** | **Float** | Price per unit in Customer currency |
12
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
+ **tax** | **Float** | Tax | [optional]
14
+ **average_cost** | **Float** | Average product cost | [optional]
15
+ **tax_rule** | **String** | Line Tax Rule name. | [optional]
16
+ **comment** | **String** | Comment for this line | [optional]
17
+ **drop_ship** | **Boolean** | Required if product is not a service with “Optional Drop Ship” mode. Otherwise it ignored. | [optional]
18
+ **backorder_quantity** | **Float** | Quantity of the ordered product on backorder. Read Only for POST | [optional]
19
+ **total** | **Float** | Line Total. For validation | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
data/docs/SalePayment.md CHANGED
@@ -4,20 +4,20 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID | [optional]
8
- **task_id** | **String** | Unique DEAR Sale Task ID. Available for POST | [optional]
9
- **id** | **String** | Identifier of payment. Available for PUT | [optional]
10
- **sale_order_number** | **String** | Sale Order Number | [optional]
11
- **invoice_number** | **String** | Sale Task Invoice Number | [optional]
12
- **credit_note_number** | **String** | Sale Task Credit Note Number | [optional]
13
- **type** | **String** | Available values are PREPAYMENT,PAYMENT,REFUND. Available for POST | [optional]
14
- **reference** | **String** | Payment reference number. Available for POST/PUT | [optional]
15
- **amount** | **Float** | Payment amount in customer currency. Available for POST/PUT | [optional]
16
- **date_paid** | **Date** | Date when payment has been made. Available for POST/PUT | [optional]
17
- **account** | **String** | Account Code of the bank/payment account from Chart of accounts. Available for POST/PUT | [optional]
18
- **currency_rate** | **Float** | Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. Available for POST/PUT | [optional]
19
- **date_created** | **Date** | Date of creation payment record. | [optional]
20
- **credit_id** | **String** | Id for Sale Credit entry | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale ID | [optional]
8
+ **task_id** | **String** | Unique DEAR Sale Task ID. Available for POST | [optional]
9
+ **id** | **String** | Identifier of payment. Available for PUT | [optional]
10
+ **sale_order_number** | **String** | Sale Order Number | [optional]
11
+ **invoice_number** | **String** | Sale Task Invoice Number | [optional]
12
+ **credit_note_number** | **String** | Sale Task Credit Note Number | [optional]
13
+ **type** | **String** | Available values are PREPAYMENT,PAYMENT,REFUND. Available for POST | [optional]
14
+ **reference** | **String** | Payment reference number. Available for POST/PUT | [optional]
15
+ **amount** | **Float** | Payment amount in customer currency. Available for POST/PUT | [optional]
16
+ **date_paid** | **Date** | Date when payment has been made. Available for POST/PUT | [optional]
17
+ **account** | **String** | Account Code of the bank/payment account from Chart of accounts. Available for POST/PUT | [optional]
18
+ **currency_rate** | **Float** | Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. Available for POST/PUT | [optional]
19
+ **date_created** | **Date** | Date of creation payment record. | [optional]
20
+ **credit_id** | **String** | Id for Sale Credit entry | [optional]
21
21
 
22
22
  ## Code Sample
23
23
 
data/docs/SalePaymentLine.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **String** | Identifier of payment. | [optional]
8
- **reference** | **String** | Payment reference number. | [optional]
9
- **amount** | **Float** | Decimal with up to 2 decimal places. Payment amount in customer currency. | [optional]
10
- **date_paid** | **Date** | Date when payment has been made. | [optional]
11
- **account** | **String** | Account Code of the bank/payment account from Chart of accounts. | [optional]
12
- **currency_rate** | **Float** | Decimal with up to 4 decimal places. Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. | [optional]
13
- **date_created** | **Date** | Date of creation payment record. | [optional]
7
+ **id** | **String** | Identifier of payment. | [optional]
8
+ **reference** | **String** | Payment reference number. | [optional]
9
+ **amount** | **Float** | Decimal with up to 2 decimal places. Payment amount in customer currency. | [optional]
10
+ **date_paid** | **Date** | Date when payment has been made. | [optional]
11
+ **account** | **String** | Account Code of the bank/payment account from Chart of accounts. | [optional]
12
+ **currency_rate** | **Float** | Decimal with up to 4 decimal places. Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. | [optional]
13
+ **date_created** | **Date** | Date of creation payment record. | [optional]
14
14
 
15
15
  ## Code Sample
16
16
 
data/docs/SaleQuote.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
8
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
9
- **memo** | **String** | Additional information for Quote. |
10
- **status** | **String** | Quote Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
11
- **lines** | [**Array<SaleQuoteLine>**](SaleQuoteLine.md) | | [optional]
12
- **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
13
- **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges without taxes. Not required for POST. |
14
- **tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges taxes. Not required for POST. |
15
- **total** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges with taxes. Not required for POST. |
9
+ **memo** | **String** | Additional information for Quote. |
10
+ **status** | **String** | Quote Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
11
+ **lines** | [**Array<SaleQuoteLine>**](SaleQuoteLine.md) | | [optional]
12
+ **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
13
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges without taxes. Not required for POST. |
14
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges taxes. Not required for POST. |
15
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges with taxes. Not required for POST. |
16
16
 
17
17
  ## Code Sample
18
18
 
data/docs/SaleQuoteLine.md CHANGED
@@ -4,17 +4,17 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
- **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
- **name** | **String** | Product Name referenced by this Line |
10
- **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
- **price** | **Float** | Price per unit in Customer currency |
12
- **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
- **tax** | **Float** | Tax | [optional]
14
- **average_cost** | **Float** | Average product cost | [optional]
15
- **tax_rule** | **String** | Line Tax Rule name. | [optional]
16
- **comment** | **String** | Comment for this line | [optional]
17
- **total** | **Float** | Line Total. For validation | [optional]
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
+ **name** | **String** | Product Name referenced by this Line |
10
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
+ **price** | **Float** | Price per unit in Customer currency |
12
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
+ **tax** | **Float** | Tax | [optional]
14
+ **average_cost** | **Float** | Average product cost | [optional]
15
+ **tax_rule** | **String** | Line Tax Rule name. | [optional]
16
+ **comment** | **String** | Comment for this line | [optional]
17
+ **total** | **Float** | Line Total. For validation | [optional]
18
18
 
19
19
  ## Code Sample
20
20
 
data/docs/ShippingAddress.md CHANGED
@@ -4,17 +4,17 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **display_address_line1** | **String** | Address Line 1 as displayed on Sale form. = Line1 + Line2 | [optional]
8
- **display_address_line2** | **String** | Address Line 2 as displayed on Sale form. = City + State/Region + Zip/Postcode + Country | [optional]
9
- **line1** | **String** | Address Line 1 |
10
- **line2** | **String** | Address Line 2 | [optional]
11
- **city** | **String** | City | [optional]
12
- **state** | **String** | State | [optional]
13
- **post_code** | **String** | Post code | [optional]
14
- **country** | **String** | Country |
15
- **company** | **String** | Company Name | [optional]
16
- **contact** | **String** | Contact | [optional]
17
- **ship_to_other** | **Boolean** | If false and Customer's address matching Line 1 not found, than new customer shipping address will be created. | [optional]
7
+ **display_address_line1** | **String** | Address Line 1 as displayed on Sale form. = Line1 + Line2 | [optional]
8
+ **display_address_line2** | **String** | Address Line 2 as displayed on Sale form. = City + State/Region + Zip/Postcode + Country | [optional]
9
+ **line1** | **String** | Address Line 1 |
10
+ **line2** | **String** | Address Line 2 | [optional]
11
+ **city** | **String** | City | [optional]
12
+ **state** | **String** | State | [optional]
13
+ **post_code** | **String** | Post code | [optional]
14
+ **country** | **String** | Country |
15
+ **company** | **String** | Company Name | [optional]
16
+ **contact** | **String** | Contact | [optional]
17
+ **ship_to_other** | **Boolean** | If false and Customer's address matching Line 1 not found, than new customer shipping address will be created. | [optional]
18
18
 
19
19
  ## Code Sample
20
20
 
data/docs/Success.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **success** | **Boolean** | Success | [optional]
7
+ **success** | **Boolean** | Success | [optional]
8
8
 
9
9
  ## Code Sample
10
10
 
data/docs/SupplierCustomerAddress.md CHANGED
@@ -4,14 +4,14 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **String** | If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created | [optional]
8
- **line1** | **String** | Address Line 1 | [optional]
9
- **line2** | **String** | Address Line 2 | [optional]
10
- **city** | **String** | City / Suburb | [optional]
11
- **state** | **String** | State / Province | [optional]
12
- **post_code** | **String** | Zip / PostCode | [optional]
13
- **country** | **String** | Country name |
14
- **type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. |
7
+ **id** | **String** | If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created | [optional]
8
+ **line1** | **String** | Address Line 1 | [optional]
9
+ **line2** | **String** | Address Line 2 | [optional]
10
+ **city** | **String** | City / Suburb | [optional]
11
+ **state** | **String** | State / Province | [optional]
12
+ **postcode** | **String** | Zip / PostCode | [optional]
13
+ **country** | **String** | Country name |
14
+ **type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. |
15
15
  **default_for_type** | **Boolean** | Points that Address is used as default for chosen Type. `false` as default. | [optional] [default to false]
16
16
 
17
17
  ## Code Sample
@@ -24,7 +24,7 @@ instance = DearInventoryRuby::SupplierCustomerAddress.new(id: nil,
24
24
  line2: nil,
25
25
  city: nil,
26
26
  state: nil,
27
- post_code: nil,
27
+ postcode: nil,
28
28
  country: nil,
29
29
  type: nil,
30
30
  default_for_type: nil)
data/docs/Tax.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **String** | Unique ID | [optional]
8
- **name** | **String** | Tax Name |
9
- **account** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` |
7
+ **id** | **String** | Unique ID | [optional]
8
+ **name** | **String** | Tax Name |
9
+ **account** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` |
10
10
  **is_active** | **Boolean** | Points that tax is Active | [default to true]
11
11
  **tax_inclusive** | **Boolean** | Points that tax is Inclusive | [default to true]
12
- **tax_percent** | **Float** | Tax percentage, should be between 0 and 100. Read-only | [optional]
12
+ **tax_percent** | **Float** | Tax percentage, should be between 0 and 100. Read-only | [optional]
13
13
  **is_tax_for_sale** | **Boolean** | Points that tax is used for Sale | [optional] [default to true]
14
14
  **is_tax_for_purchase** | **Boolean** | Points that tax is used for Purchase | [optional] [default to true]
15
- **components** | [**Array<TaxComponent>**](TaxComponent.md) | List of Tax Components | [optional]
15
+ **components** | [**Array<TaxComponent>**](TaxComponent.md) | List of Tax Components | [optional]
16
16
 
17
17
  ## Code Sample
18
18
 
data/docs/TaxComponent.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | Name of product. Read-only. |
7
+ **name** | **String** | Name of product. Read-only. |
8
8
  **percent** | **Float** | Cost. Required if product type is `Service`. Default value = 0. | [default to 0]
9
- **account_code** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` |
10
- **component_order** | **Integer** | The order of sequence taxes components. |
9
+ **account_code** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` |
10
+ **component_order** | **Integer** | The order of sequence taxes components. |
11
11
 
12
12
  ## Code Sample
13
13
 
data/docs/Taxes.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total** | **String** | Total | [optional]
8
- **page** | **String** | Page | [optional]
9
- **tax_rule_list** | [**Array<Tax>**](Tax.md) | Array of Taxes | [optional]
7
+ **total** | **String** | Total | [optional]
8
+ **page** | **String** | Page | [optional]
9
+ **tax_rule_list** | [**Array<Tax>**](Tax.md) | Array of Taxes | [optional]
10
10
 
11
11
  ## Code Sample
12
12
 
data/docs/Webhook.md CHANGED
@@ -4,16 +4,16 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **String** | Unique ID. Required for PUT | [optional]
8
- **type** | **String** | Webhook Type. Available values are values |
9
- **name** | **String** | Webhook Friendly Name. Read-only. | [optional]
10
- **is_active** | **Boolean** | Is webhook active. |
11
- **external_url** | **String** | Callback url. |
12
- **external_authorization_type** | **String** | Authorisation type. Available values are `noauth`, `basicauth` and `bearerauth` |
13
- **external_user_name** | **String** | User name. Required if `ExternalAuthorizationType` is `basicauth` | [optional]
14
- **external_password** | **String** | Password. Required if `ExternalAuthorizationType` is `basicauth` | [optional]
15
- **external_bearer_token** | **String** | Bearer token. Required if `ExternalAuthorizationType` is `bearerauth` | [optional]
16
- **external_headers** | [**Array<ExternalHeader>**](ExternalHeader.md) | Additional headers. | [optional]
7
+ **id** | **String** | Unique ID. Required for PUT | [optional]
8
+ **type** | **String** | Webhook Type. Available values are values |
9
+ **name** | **String** | Webhook Friendly Name. Read-only. | [optional]
10
+ **is_active** | **Boolean** | Is webhook active. |
11
+ **external_url** | **String** | Callback url. |
12
+ **external_authorization_type** | **String** | Authorisation type. Available values are `noauth`, `basicauth` and `bearerauth` |
13
+ **external_user_name** | **String** | User name. Required if `ExternalAuthorizationType` is `basicauth` | [optional]
14
+ **external_password** | **String** | Password. Required if `ExternalAuthorizationType` is `basicauth` | [optional]
15
+ **external_bearer_token** | **String** | Bearer token. Required if `ExternalAuthorizationType` is `bearerauth` | [optional]
16
+ **external_headers** | [**Array<ExternalHeader>**](ExternalHeader.md) | Additional headers. | [optional]
17
17
 
18
18
  ## Code Sample
19
19