dear-inventory-ruby 0.2.13 → 0.2.14
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +11 -4
- data/docs/Account.md +17 -19
- data/docs/Accounts.md +5 -7
- data/docs/Address.md +10 -12
- data/docs/AttachmentLine.md +7 -9
- data/docs/AttributeSet.md +79 -0
- data/docs/AttributeSetAttribute.md +19 -0
- data/docs/AttributeSets.md +19 -0
- data/docs/Bin.md +4 -6
- data/docs/Carrier.md +4 -6
- data/docs/Carriers.md +5 -7
- data/docs/Contact.md +13 -15
- data/docs/Customer.md +34 -36
- data/docs/Customers.md +5 -7
- data/docs/Error.md +4 -6
- data/docs/ExternalHeader.md +4 -6
- data/docs/InventoryApi.md +446 -274
- data/docs/Location.md +20 -22
- data/docs/Locations.md +5 -7
- data/docs/Me.md +9 -11
- data/docs/MeContact.md +11 -13
- data/docs/MeContacts.md +5 -7
- data/docs/PaymentTerm.md +8 -10
- data/docs/PaymentTerms.md +5 -7
- data/docs/PriceTier.md +4 -6
- data/docs/PriceTiers.md +3 -5
- data/docs/Sale.md +45 -47
- data/docs/SaleAdditionalCharge.md +10 -12
- data/docs/SaleInvoice.md +19 -21
- data/docs/SaleInvoiceAdditionalCharge.md +11 -13
- data/docs/SaleInvoiceDelete.md +4 -6
- data/docs/SaleInvoiceLine.md +14 -16
- data/docs/SaleInvoicePartial.md +15 -17
- data/docs/SaleInvoicePost.md +15 -17
- data/docs/SaleInvoices.md +4 -6
- data/docs/SaleItem.md +33 -35
- data/docs/SaleList.md +5 -7
- data/docs/SaleOrder.md +12 -14
- data/docs/SaleOrderLine.md +15 -17
- data/docs/SalePayment.md +16 -18
- data/docs/SalePaymentLine.md +9 -11
- data/docs/SaleQuote.md +11 -13
- data/docs/SaleQuoteLine.md +13 -15
- data/docs/ShippingAddress.md +13 -15
- data/docs/Success.md +3 -5
- data/docs/SupplierCustomerAddress.md +11 -13
- data/docs/Tax.md +11 -13
- data/docs/TaxComponent.md +6 -8
- data/docs/Taxes.md +5 -7
- data/docs/Webhook.md +12 -14
- data/docs/Webhooks.md +3 -5
- data/lib/dear-inventory-ruby/api/inventory_api.rb +253 -0
- data/lib/dear-inventory-ruby/models/attribute_set.rb +534 -0
- data/lib/dear-inventory-ruby/models/attribute_set_attribute.rb +237 -0
- data/lib/dear-inventory-ruby/models/attribute_sets.rb +229 -0
- data/lib/dear-inventory-ruby/version.rb +1 -1
- data/lib/dear-inventory-ruby.rb +3 -0
- data/spec/.DS_Store +0 -0
- data/spec/api/inventory_api_spec.rb +49 -0
- data/spec/models/attribute_set_attribute_spec.rb +53 -0
- data/spec/models/attribute_set_spec.rb +233 -0
- data/spec/models/attribute_sets_spec.rb +53 -0
- metadata +53 -41
data/docs/Location.md
CHANGED
|
@@ -2,26 +2,26 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**name**
|
|
9
|
-
**is_default**
|
|
10
|
-
**deprecated**
|
|
11
|
-
**bins**
|
|
12
|
-
**fixed_assets_location**
|
|
13
|
-
**parent_id**
|
|
14
|
-
**reference_count**
|
|
15
|
-
**address_line1**
|
|
16
|
-
**address_line2**
|
|
17
|
-
**address_city_suburb**
|
|
18
|
-
**address_state_province** | **String**
|
|
19
|
-
**address_zip_post_code**
|
|
20
|
-
**address_country**
|
|
21
|
-
**pick_zones**
|
|
22
|
-
**is_shopfloor**
|
|
23
|
-
**is_co_man**
|
|
24
|
-
**is_staging**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
7
|
+
| **id** | **String** | Required for `PUT` and `DELETE`, Ignored for `POST` operations | [optional] |
|
|
8
|
+
| **name** | **String** | Location name | [optional] |
|
|
9
|
+
| **is_default** | **Boolean** | Points that location is used as default | [optional] [default to false] |
|
|
10
|
+
| **deprecated** | **Boolean** | Points that location is deprecated | [optional] [default to false] |
|
|
11
|
+
| **bins** | [**Array<Bin>**](Bin.md) | Array (ID, Name) with related Bins | [optional] |
|
|
12
|
+
| **fixed_assets_location** | **Boolean** | Points that location is used as Fixed Asset | [optional] [default to false] |
|
|
13
|
+
| **parent_id** | **String** | Parent ID (used for Bins) | [optional] |
|
|
14
|
+
| **reference_count** | **Integer** | Reference linked to current location | [optional] |
|
|
15
|
+
| **address_line1** | **String** | Address line | [optional] |
|
|
16
|
+
| **address_line2** | **String** | Address line second | [optional] |
|
|
17
|
+
| **address_city_suburb** | **String** | City suburb | [optional] |
|
|
18
|
+
| **address_state_province** | **String** | State province | [optional] |
|
|
19
|
+
| **address_zip_post_code** | **String** | Zip post code | [optional] |
|
|
20
|
+
| **address_country** | **String** | Country | [optional] |
|
|
21
|
+
| **pick_zones** | **String** | Pick zones | [optional] |
|
|
22
|
+
| **is_shopfloor** | **Boolean** | Points that location is shopfloor | [optional] [default to false] |
|
|
23
|
+
| **is_co_man** | **Boolean** | Points that location is location of co-manufacturer | [optional] [default to false] |
|
|
24
|
+
| **is_staging** | **Boolean** | Points that location is staging. It is used only for Bins | [optional] [default to false] |
|
|
25
25
|
|
|
26
26
|
## Code Sample
|
|
27
27
|
|
|
@@ -47,5 +47,3 @@ instance = DearInventoryRuby::Location.new(id: nil,
|
|
|
47
47
|
is_co_man: nil,
|
|
48
48
|
is_staging: nil)
|
|
49
49
|
```
|
|
50
|
-
|
|
51
|
-
|
data/docs/Locations.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**total**
|
|
8
|
-
**page**
|
|
9
|
-
**location_list** | [**Array<Location>**](Location.md) | Array of Locations | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------- | ---------------------------------------- | ------------------ | ---------- |
|
|
7
|
+
| **total** | **Float** | Total | [optional] |
|
|
8
|
+
| **page** | **Float** | Page | [optional] |
|
|
9
|
+
| **location_list** | [**Array<Location>**](Location.md) | Array of Locations | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,5 +17,3 @@ instance = DearInventoryRuby::Locations.new(total: nil,
|
|
|
17
17
|
page: nil,
|
|
18
18
|
location_list: nil)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/Me.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**company**
|
|
8
|
-
**currency**
|
|
9
|
-
**time_zone**
|
|
10
|
-
**default_weight_units**
|
|
11
|
-
**default_dimensions_units** | **String** | Unit of measure for unit length/width/height
|
|
12
|
-
**lock_date**
|
|
13
|
-
**opening_balance_date**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **company** | **String** | Your company name | [optional] |
|
|
8
|
+
| **currency** | **String** | Your company base currency | [optional] |
|
|
9
|
+
| **time_zone** | **String** | Time Zone where your company located | [optional] |
|
|
10
|
+
| **default_weight_units** | **String** | Unit of measure for unit weight | [optional] |
|
|
11
|
+
| **default_dimensions_units** | **String** | Unit of measure for unit length/width/height | [optional] |
|
|
12
|
+
| **lock_date** | **Date** | Financial settings option. Indicates date period start from what you can change transactional data. Formatted in Tenant date format | [optional] |
|
|
13
|
+
| **opening_balance_date** | **Date** | Date of opening balances in the system. Formatted in Tenant date format | [optional] |
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
@@ -25,5 +25,3 @@ instance = DearInventoryRuby::Me.new(company: nil,
|
|
|
25
25
|
lock_date: nil,
|
|
26
26
|
opening_balance_date: nil)
|
|
27
27
|
```
|
|
28
|
-
|
|
29
|
-
|
data/docs/MeContact.md
CHANGED
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**contact_id**
|
|
8
|
-
**name**
|
|
9
|
-
**phone**
|
|
10
|
-
**fax**
|
|
11
|
-
**email**
|
|
12
|
-
**website**
|
|
13
|
-
**comment**
|
|
14
|
-
**type**
|
|
15
|
-
**default_for_type** | **Boolean** | Points that `MeContact` is used as default for chosen `Type`. `False` as default.
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
7
|
+
| **contact_id** | **String** | Unique `MeContact` ID | [optional] |
|
|
8
|
+
| **name** | **String** | Name of `MeContact` | [optional] |
|
|
9
|
+
| **phone** | **String** | Phone | [optional] |
|
|
10
|
+
| **fax** | **String** | Fax | [optional] |
|
|
11
|
+
| **email** | **String** | Email | [optional] |
|
|
12
|
+
| **website** | **String** | Website | [optional] |
|
|
13
|
+
| **comment** | **String** | Comment | [optional] |
|
|
14
|
+
| **type** | **String** | `MeContact` Type. Should be one of the following values: `Billing`, `Business`, `Sale`, `Shipping` or `Employee` | [optional] |
|
|
15
|
+
| **default_for_type** | **Boolean** | Points that `MeContact` is used as default for chosen `Type`. `False` as default. | [optional] [default to false] |
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
|
18
18
|
|
|
@@ -29,5 +29,3 @@ instance = DearInventoryRuby::MeContact.new(contact_id: nil,
|
|
|
29
29
|
type: nil,
|
|
30
30
|
default_for_type: nil)
|
|
31
31
|
```
|
|
32
|
-
|
|
33
|
-
|
data/docs/MeContacts.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**total**
|
|
8
|
-
**page**
|
|
9
|
-
**me_contacts_list** | [**Array<MeContact>**](MeContact.md) | Array of MeContacts | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------------- | ------------------------------------------ | ------------------- | ---------- |
|
|
7
|
+
| **total** | **Float** | Total | [optional] |
|
|
8
|
+
| **page** | **Float** | Page | [optional] |
|
|
9
|
+
| **me_contacts_list** | [**Array<MeContact>**](MeContact.md) | Array of MeContacts | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,5 +17,3 @@ instance = DearInventoryRuby::MeContacts.new(total: nil,
|
|
|
17
17
|
page: nil,
|
|
18
18
|
me_contacts_list: nil)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/PaymentTerm.md
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**name**
|
|
9
|
-
**duration**
|
|
10
|
-
**method**
|
|
11
|
-
**is_active**
|
|
12
|
-
**is_default** | **Boolean** | Points that Payment Term is Default. `False` as default for POST.
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
7
|
+
| **id** | **String** | Unique Payment Term ID | [optional] |
|
|
8
|
+
| **name** | **String** | Name of Payment Term |
|
|
9
|
+
| **duration** | **String** | Minimum Payment Term duration in days | [optional] |
|
|
10
|
+
| **method** | **String** | Method of Payment Term. Should be one of the following values: `number of days`, `day of next month`, `last day of next month`, `days since the end of the month` | [optional] |
|
|
11
|
+
| **is_active** | **Boolean** | Points that Payment Term is Active. `True` as default for POST. | [optional] [default to true] |
|
|
12
|
+
| **is_default** | **Boolean** | Points that Payment Term is Default. `False` as default for POST. | [optional] [default to false] |
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
@@ -23,5 +23,3 @@ instance = DearInventoryRuby::PaymentTerm.new(id: nil,
|
|
|
23
23
|
is_active: nil,
|
|
24
24
|
is_default: nil)
|
|
25
25
|
```
|
|
26
|
-
|
|
27
|
-
|
data/docs/PaymentTerms.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**total**
|
|
8
|
-
**page**
|
|
9
|
-
**payment_term_list** | [**Array<PaymentTerm>**](PaymentTerm.md) | Array of PaymentTerms | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------------- | ---------------------------------------------- | --------------------- | ---------- |
|
|
7
|
+
| **total** | **String** | Total | [optional] |
|
|
8
|
+
| **page** | **String** | Page | [optional] |
|
|
9
|
+
| **payment_term_list** | [**Array<PaymentTerm>**](PaymentTerm.md) | Array of PaymentTerms | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,5 +17,3 @@ instance = DearInventoryRuby::PaymentTerms.new(total: nil,
|
|
|
17
17
|
page: nil,
|
|
18
18
|
payment_term_list: nil)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/PriceTier.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**code** | **Integer** | Code number of Price Tier | [optional]
|
|
8
|
-
**name** | **String**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------- | ----------- | ------------------------- | ---------- |
|
|
7
|
+
| **code** | **Integer** | Code number of Price Tier | [optional] |
|
|
8
|
+
| **name** | **String** | Price Tier name | [optional] |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -15,5 +15,3 @@ require 'DearInventoryRuby'
|
|
|
15
15
|
instance = DearInventoryRuby::PriceTier.new(code: nil,
|
|
16
16
|
name: nil)
|
|
17
17
|
```
|
|
18
|
-
|
|
19
|
-
|
data/docs/PriceTiers.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**price_tiers** | [**Array<PriceTier>**](PriceTier.md) | Array of PriceTiers | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ------------------------------------------ | ------------------- | ---------- |
|
|
7
|
+
| **price_tiers** | [**Array<PriceTier>**](PriceTier.md) | Array of PriceTiers | [optional] |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
@@ -13,5 +13,3 @@ require 'DearInventoryRuby'
|
|
|
13
13
|
|
|
14
14
|
instance = DearInventoryRuby::PriceTiers.new(price_tiers: nil)
|
|
15
15
|
```
|
|
16
|
-
|
|
17
|
-
|
data/docs/Sale.md
CHANGED
|
@@ -2,51 +2,51 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**customer**
|
|
9
|
-
**customer_id**
|
|
10
|
-
**contact**
|
|
11
|
-
**phone**
|
|
12
|
-
**email**
|
|
13
|
-
**default_account**
|
|
14
|
-
**skip_quote**
|
|
15
|
-
**billing_address**
|
|
16
|
-
**shipping_address**
|
|
17
|
-
**shipping_notes**
|
|
18
|
-
**base_currency**
|
|
19
|
-
**customer_currency**
|
|
20
|
-
**tax_rule**
|
|
21
|
-
**tax_calculation**
|
|
22
|
-
**terms**
|
|
23
|
-
**price_tier**
|
|
24
|
-
**ship_by**
|
|
25
|
-
**location**
|
|
26
|
-
**sale_order_date**
|
|
27
|
-
**last_modified_on**
|
|
28
|
-
**note**
|
|
29
|
-
**customer_reference**
|
|
30
|
-
**cogs_amount**
|
|
31
|
-
**status**
|
|
32
|
-
**combined_picking_status**
|
|
33
|
-
**combined_packing_status**
|
|
34
|
-
**combined_shipping_status**
|
|
35
|
-
**ful_filment_status**
|
|
36
|
-
**combined_invoice_status**
|
|
37
|
-
**combined_payment_status**
|
|
38
|
-
**combined_tracking_numbers** | **String**
|
|
39
|
-
**carrier**
|
|
40
|
-
**currency_rate**
|
|
41
|
-
**sales_representative**
|
|
42
|
-
**type**
|
|
43
|
-
**source_channel**
|
|
44
|
-
**external_id**
|
|
45
|
-
**service_only**
|
|
46
|
-
**quote**
|
|
47
|
-
**order**
|
|
48
|
-
**invoices**
|
|
49
|
-
**attachments**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **id** | **String** | Unique DEAR Sale ID. Required for PUT | [optional] |
|
|
8
|
+
| **customer** | **String** | Customer name | [optional] |
|
|
9
|
+
| **customer_id** | **String** | Customer identifier | [optional] |
|
|
10
|
+
| **contact** | **String** | Customer Contact name | [optional] |
|
|
11
|
+
| **phone** | **String** | Customer Contact phone | [optional] |
|
|
12
|
+
| **email** | **String** | Customer Contact email | [optional] |
|
|
13
|
+
| **default_account** | **String** | Account code used by default for invoice lines when no revenue account is defined on Product. By default it is equal to Customer Sale account | [optional] |
|
|
14
|
+
| **skip_quote** | **Boolean** | True if there is no quote in the sale | [optional] |
|
|
15
|
+
| **billing_address** | [**Address**](Address.md) | | [optional] |
|
|
16
|
+
| **shipping_address** | [**ShippingAddress**](ShippingAddress.md) | | [optional] |
|
|
17
|
+
| **shipping_notes** | **String** | Shipping Notes | [optional] |
|
|
18
|
+
| **base_currency** | **String** | 3 character currency code of Base Currency defined in General Settings on the moment when Sale was created. | [optional] |
|
|
19
|
+
| **customer_currency** | **String** | 3 character currency code of customer Currency defined in Customer card at the moment when customer is selected for the Sale. | [optional] |
|
|
20
|
+
| **tax_rule** | **String** | Default Tax Rule name selected for Sale | [optional] |
|
|
21
|
+
| **tax_calculation** | **String** | Inclusive or Exclusive | [optional] |
|
|
22
|
+
| **terms** | **String** | Payment terms name | [optional] |
|
|
23
|
+
| **price_tier** | **String** | Price Tier name selected for Sale | [optional] |
|
|
24
|
+
| **ship_by** | **Date** | Date when shipment is due | [optional] |
|
|
25
|
+
| **location** | **String** | Default location to pick stock from | [optional] |
|
|
26
|
+
| **sale_order_date** | **Date** | Date when task was created | [optional] |
|
|
27
|
+
| **last_modified_on** | **Date** | UTC Time | [optional] |
|
|
28
|
+
| **note** | **String** | Custom Sale note | [optional] |
|
|
29
|
+
| **customer_reference** | **String** | Reference number used by customer to identify this sale. Could be a purchase order number generated by customer. | [optional] |
|
|
30
|
+
| **cogs_amount** | **Float** | COGS amount in base currency | [optional] |
|
|
31
|
+
| **status** | **String** | Sale Status, see possible values | [optional] |
|
|
32
|
+
| **combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional] |
|
|
33
|
+
| **combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional] |
|
|
34
|
+
| **combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional] |
|
|
35
|
+
| **ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional] |
|
|
36
|
+
| **combined_invoice_status** | **String** | Invoice status. Possible Values are INVOICED, INVOICED / CREDITED, NOT AVAILABLE, NOT INVOICED, PARTIALLY INVOICED, PARTIALLY INVOICED / CREDITED | [optional] |
|
|
37
|
+
| **combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional] |
|
|
38
|
+
| **combined_tracking_numbers** | **String** | Tracking Numbers | [optional] |
|
|
39
|
+
| **carrier** | **String** | Name of Carrier/shipping method | [optional] |
|
|
40
|
+
| **currency_rate** | **Float** | Conversion Rate expressed as number of Base currency units for one Customer currency unit | [optional] |
|
|
41
|
+
| **sales_representative** | **String** | Sales representative name | [optional] |
|
|
42
|
+
| **type** | **String** | Type of sale Simple Sale or Advanced Sale, Service Sale | [optional] |
|
|
43
|
+
| **source_channel** | **String** | Source of the sale. read-only field | [optional] |
|
|
44
|
+
| **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] |
|
|
45
|
+
| **service_only** | **String** | true when it is service-only sale | [optional] |
|
|
46
|
+
| **quote** | [**SaleQuote**](SaleQuote.md) | | [optional] |
|
|
47
|
+
| **order** | [**SaleOrder**](SaleOrder.md) | | [optional] |
|
|
48
|
+
| **invoices** | [**Array<SaleInvoice>**](SaleInvoice.md) | Sale Invoices | [optional] |
|
|
49
|
+
| **attachments** | [**Array<AttachmentLine>**](AttachmentLine.md) | Sale Attachments | [optional] |
|
|
50
50
|
|
|
51
51
|
## Code Sample
|
|
52
52
|
|
|
@@ -97,5 +97,3 @@ instance = DearInventoryRuby::Sale.new(id: nil,
|
|
|
97
97
|
invoices: nil,
|
|
98
98
|
attachments: nil)
|
|
99
99
|
```
|
|
100
|
-
|
|
101
|
-
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**description** | **String** | Name of Service Product referenced by this Line
|
|
8
|
-
**price**
|
|
9
|
-
**quantity**
|
|
10
|
-
**discount**
|
|
11
|
-
**tax**
|
|
12
|
-
**total**
|
|
13
|
-
**tax_rule**
|
|
14
|
-
**comment**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **description** | **String** | Name of Service Product referenced by this Line |
|
|
8
|
+
| **price** | **Float** | Decimal with up to 4 decimal places. Price per unit in Customer currency |
|
|
9
|
+
| **quantity** | **Float** | Decimal with up to 4 decimal places. Product or service quantity. Minimal value is 1. |
|
|
10
|
+
| **discount** | **Float** | Decimal with up to 2 decimal places. Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional] |
|
|
11
|
+
| **tax** | **Float** | Decimal with up to 4 decimal places. Tax. |
|
|
12
|
+
| **total** | **Float** | Decimal with up to 4 decimal places. Line Total. For validation | [optional] |
|
|
13
|
+
| **tax_rule** | **String** | Line Tax Rule name. |
|
|
14
|
+
| **comment** | **Float** | Comment | [optional] |
|
|
15
15
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
|
@@ -27,5 +27,3 @@ instance = DearInventoryRuby::SaleAdditionalCharge.new(description: nil,
|
|
|
27
27
|
tax_rule: nil,
|
|
28
28
|
comment: nil)
|
|
29
29
|
```
|
|
30
|
-
|
|
31
|
-
|
data/docs/SaleInvoice.md
CHANGED
|
@@ -2,25 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**task_id**
|
|
8
|
-
**invoice_number**
|
|
9
|
-
**memo**
|
|
10
|
-
**status**
|
|
11
|
-
**invoice_date**
|
|
12
|
-
**invoice_due_date**
|
|
13
|
-
**currency_conversion_rate**
|
|
14
|
-
**billing_address_line1**
|
|
15
|
-
**billing_address_line2**
|
|
16
|
-
**linked_fulfillment_number** | **Integer**
|
|
17
|
-
**lines**
|
|
18
|
-
**additional_charges**
|
|
19
|
-
**payments**
|
|
20
|
-
**total_before_tax**
|
|
21
|
-
**tax**
|
|
22
|
-
**total**
|
|
23
|
-
**paid**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
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] |
|
|
24
24
|
|
|
25
25
|
## Code Sample
|
|
26
26
|
|
|
@@ -45,5 +45,3 @@ instance = DearInventoryRuby::SaleInvoice.new(task_id: nil,
|
|
|
45
45
|
total: nil,
|
|
46
46
|
paid: nil)
|
|
47
47
|
```
|
|
48
|
-
|
|
49
|
-
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**description** | **String** | Name of Service Product referenced by this Line
|
|
8
|
-
**quantity**
|
|
9
|
-
**price**
|
|
10
|
-
**discount**
|
|
11
|
-
**tax**
|
|
12
|
-
**total**
|
|
13
|
-
**tax_rule**
|
|
14
|
-
**account**
|
|
15
|
-
**comment**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
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] |
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
|
18
18
|
|
|
@@ -29,5 +29,3 @@ instance = DearInventoryRuby::SaleInvoiceAdditionalCharge.new(description: nil,
|
|
|
29
29
|
account: nil,
|
|
30
30
|
comment: nil)
|
|
31
31
|
```
|
|
32
|
-
|
|
33
|
-
|
data/docs/SaleInvoiceDelete.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**task_id** | **String**
|
|
8
|
-
**void**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------- | ----------- | ------------------------------- | ----------------------------- |
|
|
7
|
+
| **task_id** | **String** | ID of Sale task to Void or Undo |
|
|
8
|
+
| **void** | **Boolean** | Default false | [optional] [default to false] |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -15,5 +15,3 @@ require 'DearInventoryRuby'
|
|
|
15
15
|
instance = DearInventoryRuby::SaleInvoiceDelete.new(task_id: nil,
|
|
16
16
|
void: nil)
|
|
17
17
|
```
|
|
18
|
-
|
|
19
|
-
|
data/docs/SaleInvoiceLine.md
CHANGED
|
@@ -2,20 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**product_id**
|
|
8
|
-
**sku**
|
|
9
|
-
**name**
|
|
10
|
-
**quantity**
|
|
11
|
-
**price**
|
|
12
|
-
**discount**
|
|
13
|
-
**tax**
|
|
14
|
-
**total**
|
|
15
|
-
**average_cost** | **Float**
|
|
16
|
-
**tax_rule**
|
|
17
|
-
**account**
|
|
18
|
-
**comment**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
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] |
|
|
19
19
|
|
|
20
20
|
## Code Sample
|
|
21
21
|
|
|
@@ -35,5 +35,3 @@ instance = DearInventoryRuby::SaleInvoiceLine.new(product_id: nil,
|
|
|
35
35
|
account: nil,
|
|
36
36
|
comment: nil)
|
|
37
37
|
```
|
|
38
|
-
|
|
39
|
-
|