dear-inventory-ruby 0.2.11 → 0.2.12
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/docs/Account.md +15 -15
- data/docs/Accounts.md +3 -3
- data/docs/Address.md +8 -8
- data/docs/AttachmentLine.md +5 -5
- data/docs/Bin.md +2 -2
- data/docs/Carrier.md +2 -2
- data/docs/Carriers.md +3 -3
- data/docs/Contact.md +9 -9
- data/docs/Customer.md +31 -31
- data/docs/Customers.md +3 -3
- data/docs/Error.md +2 -2
- data/docs/ExternalHeader.md +2 -2
- data/docs/InventoryApi.md +64 -64
- data/docs/Location.md +12 -12
- data/docs/Locations.md +3 -3
- data/docs/Me.md +7 -7
- data/docs/MeContact.md +8 -8
- data/docs/MeContacts.md +3 -3
- data/docs/PaymentTerm.md +4 -4
- data/docs/PaymentTerms.md +3 -3
- data/docs/PriceTier.md +2 -2
- data/docs/PriceTiers.md +1 -1
- data/docs/Sale.md +43 -43
- data/docs/SaleAdditionalCharge.md +8 -8
- data/docs/SaleInvoice.md +17 -17
- data/docs/SaleInvoiceAdditionalCharge.md +9 -9
- data/docs/SaleInvoiceDelete.md +1 -1
- data/docs/SaleInvoiceLine.md +12 -12
- data/docs/SaleInvoicePartial.md +12 -12
- data/docs/SaleInvoicePost.md +12 -12
- data/docs/SaleInvoices.md +2 -2
- data/docs/SaleItem.md +31 -31
- data/docs/SaleList.md +3 -3
- data/docs/SaleOrder.md +9 -9
- data/docs/SaleOrderLine.md +13 -13
- data/docs/SalePayment.md +14 -14
- data/docs/SalePaymentLine.md +7 -7
- data/docs/SaleQuote.md +8 -8
- data/docs/SaleQuoteLine.md +11 -11
- data/docs/ShippingAddress.md +11 -11
- data/docs/Success.md +1 -1
- data/docs/SupplierCustomerAddress.md +9 -9
- data/docs/Tax.md +5 -5
- data/docs/TaxComponent.md +3 -3
- data/docs/Taxes.md +3 -3
- data/docs/Webhook.md +10 -10
- data/docs/Webhooks.md +1 -1
- data/lib/dear-inventory-ruby/models/supplier_customer_address.rb +7 -7
- data/lib/dear-inventory-ruby/version.rb +1 -1
- data/spec/.DS_Store +0 -0
- data/spec/models/supplier_customer_address_spec.rb +1 -1
- metadata +3 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0b398acfbb9c3baa9e2a9420189210b9e255eeaa20f2ae30d06e6e90d531946c
|
4
|
+
data.tar.gz: 448315fbb73cce0397599d25d04521533d69306a3ab269b8974bce458bd6de84
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 242d613f5ce9e65ce672e504bcffbfccde41bee7618f199a0d80e39969f0785c0029b0e62c1563870ee99b5eb5fd04b471427aa0a45d03313adc088d9d03e272
|
7
|
+
data.tar.gz: 9f10dab1dafd5b9590ca5cb5e0945636f2d021e3c648b0340a8bc3cc3a3a85678c293515024a5d7f64ee8fb2f522e53cc4e6df5f24287a55b565b819876ac732
|
data/CHANGELOG.md
CHANGED
data/docs/Account.md
CHANGED
@@ -4,21 +4,21 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**code** | **String** | Unique code of Account |
|
8
|
-
**name** | **String** | Account Name |
|
9
|
-
**type** | **String** | Type |
|
10
|
-
**status** | **String** | Account status |
|
11
|
-
**description** | **String** | Account description | [optional]
|
12
|
-
**_class** | **String** | Should be one of the following values: `ASSET`, `LIABILITY`, `EXPENSE`, `EQUITY`, `REVENUE` | [optional]
|
13
|
-
**system_account** | **String** | SystemAccount | [optional]
|
14
|
-
**system_account_code** | **String** | SystemAccountCode | [optional]
|
15
|
-
**for_payments** | **String** | Account status | [optional]
|
16
|
-
**display_name** | **String** | Account display name. Read-only. | [optional]
|
17
|
-
**old_code** | **String** | Read-only. | [optional]
|
18
|
-
**bank** | **String** | Name of the Bank. Only for PUT and POST. Required if Account Type is BANK. | [optional]
|
19
|
-
**bank_account_number** | **String** | Bank Account Number. Only for PUT and POST. Required if Account Type is BANK. | [optional]
|
20
|
-
**bank_account_id** | **String** | Bank Account ID to which the Account is linked. Read-only. | [optional]
|
21
|
-
**currency** | **String** | Currency. Read-only. | [optional]
|
7
|
+
**code** | **String** | Unique code of Account |
|
8
|
+
**name** | **String** | Account Name |
|
9
|
+
**type** | **String** | Type |
|
10
|
+
**status** | **String** | Account status |
|
11
|
+
**description** | **String** | Account description | [optional]
|
12
|
+
**_class** | **String** | Should be one of the following values: `ASSET`, `LIABILITY`, `EXPENSE`, `EQUITY`, `REVENUE` | [optional]
|
13
|
+
**system_account** | **String** | SystemAccount | [optional]
|
14
|
+
**system_account_code** | **String** | SystemAccountCode | [optional]
|
15
|
+
**for_payments** | **String** | Account status | [optional]
|
16
|
+
**display_name** | **String** | Account display name. Read-only. | [optional]
|
17
|
+
**old_code** | **String** | Read-only. | [optional]
|
18
|
+
**bank** | **String** | Name of the Bank. Only for PUT and POST. Required if Account Type is BANK. | [optional]
|
19
|
+
**bank_account_number** | **String** | Bank Account Number. Only for PUT and POST. Required if Account Type is BANK. | [optional]
|
20
|
+
**bank_account_id** | **String** | Bank Account ID to which the Account is linked. Read-only. | [optional]
|
21
|
+
**currency** | **String** | Currency. Read-only. | [optional]
|
22
22
|
|
23
23
|
## Code Sample
|
24
24
|
|
data/docs/Accounts.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
|
-
**accounts_list** | [**Array<Account>**](Account.md) | Array of Accounts | [optional]
|
7
|
+
**total** | **String** | Total | [optional]
|
8
|
+
**page** | **String** | Page | [optional]
|
9
|
+
**accounts_list** | [**Array<Account>**](Account.md) | Array of Accounts | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
data/docs/Address.md
CHANGED
@@ -4,14 +4,14 @@
|
|
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** | PostCode | [optional]
|
14
|
-
**country** | **String** | Country |
|
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** | PostCode | [optional]
|
14
|
+
**country** | **String** | Country |
|
15
15
|
|
16
16
|
## Code Sample
|
17
17
|
|
data/docs/AttachmentLine.md
CHANGED
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **String** | Attached file ID | [optional]
|
8
|
-
**content_type** | **String** | Attached file content type | [optional]
|
9
|
-
**is_default** | **Boolean** | Is this attachment will be used as default product image. Is visible only for product Attachment Endpoint. | [optional]
|
10
|
-
**file_name** | **String** | Attached file name | [optional]
|
11
|
-
**download_url** | **String** | Url to download attached File | [optional]
|
7
|
+
**id** | **String** | Attached file ID | [optional]
|
8
|
+
**content_type** | **String** | Attached file content type | [optional]
|
9
|
+
**is_default** | **Boolean** | Is this attachment will be used as default product image. Is visible only for product Attachment Endpoint. | [optional]
|
10
|
+
**file_name** | **String** | Attached file name | [optional]
|
11
|
+
**download_url** | **String** | Url to download attached File | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
14
14
|
|
data/docs/Bin.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **String** | Unique ID | [optional]
|
8
|
-
**name** | **String** | Name of `Bin` | [optional]
|
7
|
+
**id** | **String** | Unique ID | [optional]
|
8
|
+
**name** | **String** | Name of `Bin` | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/Carrier.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**carrier_id** | **String** | Unique `Carrier` ID | [optional]
|
8
|
-
**description** | **String** | Name of `Carrier` | [optional]
|
7
|
+
**carrier_id** | **String** | Unique `Carrier` ID | [optional]
|
8
|
+
**description** | **String** | Name of `Carrier` | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/Carriers.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
|
-
**carrier_list** | [**Array<Carrier>**](Carrier.md) | Array of Carriers | [optional]
|
7
|
+
**total** | **Float** | Total | [optional]
|
8
|
+
**page** | **Float** | Page | [optional]
|
9
|
+
**carrier_list** | [**Array<Carrier>**](Carrier.md) | Array of Carriers | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
data/docs/Contact.md
CHANGED
@@ -4,15 +4,15 @@
|
|
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
|
-
**name** | **String** | Name of Contact |
|
9
|
-
**job_title** | **String** | Job Title | [optional]
|
10
|
-
**phone** | **String** | Phone | [optional]
|
11
|
-
**mobile_phone** | **String** | Mobile Phone | [optional]
|
12
|
-
**fax** | **String** | Fax | [optional]
|
13
|
-
**email** | **String** | Email | [optional]
|
14
|
-
**website** | **String** | Website | [optional]
|
15
|
-
**comment** | **String** | Comment | [optional]
|
7
|
+
**id** | **String** | If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created | [optional]
|
8
|
+
**name** | **String** | Name of Contact |
|
9
|
+
**job_title** | **String** | Job Title | [optional]
|
10
|
+
**phone** | **String** | Phone | [optional]
|
11
|
+
**mobile_phone** | **String** | Mobile Phone | [optional]
|
12
|
+
**fax** | **String** | Fax | [optional]
|
13
|
+
**email** | **String** | Email | [optional]
|
14
|
+
**website** | **String** | Website | [optional]
|
15
|
+
**comment** | **String** | Comment | [optional]
|
16
16
|
**default** | **Boolean** | Points that Contact is used as default. `false` as default. | [optional] [default to false]
|
17
17
|
**include_in_email** | **Boolean** | Points that Contact is included in Email. `false` as default. | [optional] [default to false]
|
18
18
|
|
data/docs/Customer.md
CHANGED
@@ -4,38 +4,38 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **String** | Unique Customer ID | [optional]
|
8
|
-
**name** | **String** | Name of Customer |
|
9
|
-
**status** | **String** | Points that Customer is Active. Available values are Active and Deprecated. Required for POST |
|
10
|
-
**currency** | **String** | Currency code of Customer |
|
11
|
-
**payment_term** | **String** | Payment term |
|
12
|
-
**account_receivable** | **String** | Account receivable code of Customer |
|
13
|
-
**revenue_account** | **String** | Sale account code of Customer |
|
14
|
-
**tax_rule** | **String** | Tax rule name |
|
15
|
-
**price_tier** | **String** | Price tier | [optional]
|
16
|
-
**carrier** | **String** | Carrier name | [optional]
|
17
|
-
**sales_representative** | **String** | Sales representative | [optional]
|
18
|
-
**location** | **String** | Location | [optional]
|
19
|
-
**discount** | **Float** | Discount must be between 0% and 100% | [optional]
|
20
|
-
**comments** | **String** | Comments | [optional]
|
21
|
-
**tax_number** | **String** | Tax number | [optional]
|
22
|
-
**credit_limit** | **Float** | Credit limit | [optional]
|
7
|
+
**id** | **String** | Unique Customer ID | [optional]
|
8
|
+
**name** | **String** | Name of Customer |
|
9
|
+
**status** | **String** | Points that Customer is Active. Available values are Active and Deprecated. Required for POST |
|
10
|
+
**currency** | **String** | Currency code of Customer |
|
11
|
+
**payment_term** | **String** | Payment term |
|
12
|
+
**account_receivable** | **String** | Account receivable code of Customer |
|
13
|
+
**revenue_account** | **String** | Sale account code of Customer |
|
14
|
+
**tax_rule** | **String** | Tax rule name |
|
15
|
+
**price_tier** | **String** | Price tier | [optional]
|
16
|
+
**carrier** | **String** | Carrier name | [optional]
|
17
|
+
**sales_representative** | **String** | Sales representative | [optional]
|
18
|
+
**location** | **String** | Location | [optional]
|
19
|
+
**discount** | **Float** | Discount must be between 0% and 100% | [optional]
|
20
|
+
**comments** | **String** | Comments | [optional]
|
21
|
+
**tax_number** | **String** | Tax number | [optional]
|
22
|
+
**credit_limit** | **Float** | Credit limit | [optional]
|
23
23
|
**is_on_credit_hold** | **Boolean** | boolean to indicate if a customer is on credit hold | [optional] [default to false]
|
24
|
-
**tags** | **String** | Tags string | [optional]
|
25
|
-
**attribute_set** | **String** | AttributeSet name | [optional]
|
26
|
-
**additional_attribute1** | **String** | Additional attribute 1 value | [optional]
|
27
|
-
**additional_attribute2** | **String** | Additional attribute 2 value | [optional]
|
28
|
-
**additional_attribute3** | **String** | Additional attribute 3 value | [optional]
|
29
|
-
**additional_attribute4** | **String** | Additional attribute 4 value | [optional]
|
30
|
-
**additional_attribute5** | **String** | Additional attribute 5 value | [optional]
|
31
|
-
**additional_attribute6** | **String** | Additional attribute 6 value | [optional]
|
32
|
-
**additional_attribute7** | **String** | Additional attribute 7 value | [optional]
|
33
|
-
**additional_attribute8** | **String** | Additional attribute 8 value | [optional]
|
34
|
-
**additional_attribute9** | **String** | Additional attribute 9 value | [optional]
|
35
|
-
**additional_attribute10** | **String** | Additional attribute 10 value | [optional]
|
36
|
-
**last_modified_on** | **String** | Date of last modification | [optional]
|
37
|
-
**addresses** | [**Array<SupplierCustomerAddress>**](SupplierCustomerAddress.md) | List of addresses | [optional]
|
38
|
-
**contacts** | [**Array<Contact>**](Contact.md) | List of contacts | [optional]
|
24
|
+
**tags** | **String** | Tags string | [optional]
|
25
|
+
**attribute_set** | **String** | AttributeSet name | [optional]
|
26
|
+
**additional_attribute1** | **String** | Additional attribute 1 value | [optional]
|
27
|
+
**additional_attribute2** | **String** | Additional attribute 2 value | [optional]
|
28
|
+
**additional_attribute3** | **String** | Additional attribute 3 value | [optional]
|
29
|
+
**additional_attribute4** | **String** | Additional attribute 4 value | [optional]
|
30
|
+
**additional_attribute5** | **String** | Additional attribute 5 value | [optional]
|
31
|
+
**additional_attribute6** | **String** | Additional attribute 6 value | [optional]
|
32
|
+
**additional_attribute7** | **String** | Additional attribute 7 value | [optional]
|
33
|
+
**additional_attribute8** | **String** | Additional attribute 8 value | [optional]
|
34
|
+
**additional_attribute9** | **String** | Additional attribute 9 value | [optional]
|
35
|
+
**additional_attribute10** | **String** | Additional attribute 10 value | [optional]
|
36
|
+
**last_modified_on** | **String** | Date of last modification | [optional]
|
37
|
+
**addresses** | [**Array<SupplierCustomerAddress>**](SupplierCustomerAddress.md) | List of addresses | [optional]
|
38
|
+
**contacts** | [**Array<Contact>**](Contact.md) | List of contacts | [optional]
|
39
39
|
|
40
40
|
## Code Sample
|
41
41
|
|
data/docs/Customers.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
|
-
**customer_list** | [**Array<Customer>**](Customer.md) | Array of Customers | [optional]
|
7
|
+
**total** | **String** | Total | [optional]
|
8
|
+
**page** | **String** | Page | [optional]
|
9
|
+
**customer_list** | [**Array<Customer>**](Customer.md) | Array of Customers | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
data/docs/Error.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**error_code** | **Integer** | Exception number | [optional]
|
8
|
-
**exception** | **String** | Exception message | [optional]
|
7
|
+
**error_code** | **Integer** | Exception number | [optional]
|
8
|
+
**exception** | **String** | Exception message | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/ExternalHeader.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**key** | **String** | Key | [optional]
|
8
|
-
**value** | **String** | Value | [optional]
|
7
|
+
**key** | **String** | Key | [optional]
|
8
|
+
**value** | **String** | Value | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InventoryApi.md
CHANGED
@@ -87,7 +87,7 @@ end
|
|
87
87
|
|
88
88
|
Name | Type | Description | Notes
|
89
89
|
------------- | ------------- | ------------- | -------------
|
90
|
-
**account** | [**Account**](Account.md)| an Account object with properties to create |
|
90
|
+
**account** | [**Account**](Account.md)| an Account object with properties to create |
|
91
91
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
92
92
|
|
93
93
|
### Return type
|
@@ -148,7 +148,7 @@ end
|
|
148
148
|
|
149
149
|
Name | Type | Description | Notes
|
150
150
|
------------- | ------------- | ------------- | -------------
|
151
|
-
**customer** | [**Customer**](Customer.md)| a customer object with properties to create |
|
151
|
+
**customer** | [**Customer**](Customer.md)| a customer object with properties to create |
|
152
152
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
153
153
|
|
154
154
|
### Return type
|
@@ -209,7 +209,7 @@ end
|
|
209
209
|
|
210
210
|
Name | Type | Description | Notes
|
211
211
|
------------- | ------------- | ------------- | -------------
|
212
|
-
**payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to create |
|
212
|
+
**payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to create |
|
213
213
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
214
214
|
|
215
215
|
### Return type
|
@@ -270,7 +270,7 @@ end
|
|
270
270
|
|
271
271
|
Name | Type | Description | Notes
|
272
272
|
------------- | ------------- | ------------- | -------------
|
273
|
-
**sale_invoice_post** | [**SaleInvoicePost**](SaleInvoicePost.md)| a Sale Invoice object with properties to create |
|
273
|
+
**sale_invoice_post** | [**SaleInvoicePost**](SaleInvoicePost.md)| a Sale Invoice object with properties to create |
|
274
274
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
275
275
|
|
276
276
|
### Return type
|
@@ -331,7 +331,7 @@ end
|
|
331
331
|
|
332
332
|
Name | Type | Description | Notes
|
333
333
|
------------- | ------------- | ------------- | -------------
|
334
|
-
**sale_order** | [**SaleOrder**](SaleOrder.md)| a Sale Order object with properties to create |
|
334
|
+
**sale_order** | [**SaleOrder**](SaleOrder.md)| a Sale Order object with properties to create |
|
335
335
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
336
336
|
|
337
337
|
### Return type
|
@@ -392,7 +392,7 @@ end
|
|
392
392
|
|
393
393
|
Name | Type | Description | Notes
|
394
394
|
------------- | ------------- | ------------- | -------------
|
395
|
-
**sale_payment** | [**SalePayment**](SalePayment.md)| a Sale Payment object with properties to create |
|
395
|
+
**sale_payment** | [**SalePayment**](SalePayment.md)| a Sale Payment object with properties to create |
|
396
396
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
397
397
|
|
398
398
|
### Return type
|
@@ -453,7 +453,7 @@ end
|
|
453
453
|
|
454
454
|
Name | Type | Description | Notes
|
455
455
|
------------- | ------------- | ------------- | -------------
|
456
|
-
**sale_quote** | [**SaleQuote**](SaleQuote.md)| a Sale Quote object with properties to create |
|
456
|
+
**sale_quote** | [**SaleQuote**](SaleQuote.md)| a Sale Quote object with properties to create |
|
457
457
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
458
458
|
|
459
459
|
### Return type
|
@@ -514,7 +514,7 @@ end
|
|
514
514
|
|
515
515
|
Name | Type | Description | Notes
|
516
516
|
------------- | ------------- | ------------- | -------------
|
517
|
-
**tax** | [**Tax**](Tax.md)| a tax object with properties to create |
|
517
|
+
**tax** | [**Tax**](Tax.md)| a tax object with properties to create |
|
518
518
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
519
519
|
|
520
520
|
### Return type
|
@@ -575,7 +575,7 @@ end
|
|
575
575
|
|
576
576
|
Name | Type | Description | Notes
|
577
577
|
------------- | ------------- | ------------- | -------------
|
578
|
-
**webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to create |
|
578
|
+
**webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to create |
|
579
579
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
580
580
|
|
581
581
|
### Return type
|
@@ -635,7 +635,7 @@ end
|
|
635
635
|
|
636
636
|
Name | Type | Description | Notes
|
637
637
|
------------- | ------------- | ------------- | -------------
|
638
|
-
**code** | **String**| Default is nil | [optional]
|
638
|
+
**code** | **String**| Default is nil | [optional]
|
639
639
|
|
640
640
|
### Return type
|
641
641
|
|
@@ -694,7 +694,7 @@ end
|
|
694
694
|
|
695
695
|
Name | Type | Description | Notes
|
696
696
|
------------- | ------------- | ------------- | -------------
|
697
|
-
**id** | **String**| Default is nil | [optional]
|
697
|
+
**id** | **String**| Default is nil | [optional]
|
698
698
|
|
699
699
|
### Return type
|
700
700
|
|
@@ -754,7 +754,7 @@ end
|
|
754
754
|
|
755
755
|
Name | Type | Description | Notes
|
756
756
|
------------- | ------------- | ------------- | -------------
|
757
|
-
**task_id** | **String**| ID of Sale task to Void or Undo | [optional]
|
757
|
+
**task_id** | **String**| ID of Sale task to Void or Undo | [optional]
|
758
758
|
**void** | **Boolean**| Default is false | [optional] [default to false]
|
759
759
|
|
760
760
|
### Return type
|
@@ -814,7 +814,7 @@ end
|
|
814
814
|
|
815
815
|
Name | Type | Description | Notes
|
816
816
|
------------- | ------------- | ------------- | -------------
|
817
|
-
**id** | **String**| Default is nil | [optional]
|
817
|
+
**id** | **String**| Default is nil | [optional]
|
818
818
|
|
819
819
|
### Return type
|
820
820
|
|
@@ -873,7 +873,7 @@ end
|
|
873
873
|
|
874
874
|
Name | Type | Description | Notes
|
875
875
|
------------- | ------------- | ------------- | -------------
|
876
|
-
**id** | **String**| Default is nil | [optional]
|
876
|
+
**id** | **String**| Default is nil | [optional]
|
877
877
|
|
878
878
|
### Return type
|
879
879
|
|
@@ -940,11 +940,11 @@ Name | Type | Description | Notes
|
|
940
940
|
------------- | ------------- | ------------- | -------------
|
941
941
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
942
942
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
943
|
-
**code** | **String**| Default is nil | [optional]
|
944
|
-
**name** | **String**| Default is nil | [optional]
|
945
|
-
**_class** | **String**| Default is nil | [optional]
|
946
|
-
**type** | **String**| Default is nil | [optional]
|
947
|
-
**status** | **String**| Default is nil | [optional]
|
943
|
+
**code** | **String**| Default is nil | [optional]
|
944
|
+
**name** | **String**| Default is nil | [optional]
|
945
|
+
**_class** | **String**| Default is nil | [optional]
|
946
|
+
**type** | **String**| Default is nil | [optional]
|
947
|
+
**status** | **String**| Default is nil | [optional]
|
948
948
|
|
949
949
|
### Return type
|
950
950
|
|
@@ -1008,8 +1008,8 @@ Name | Type | Description | Notes
|
|
1008
1008
|
------------- | ------------- | ------------- | -------------
|
1009
1009
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
1010
1010
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
1011
|
-
**carrier_id** | **String**| Only return Carrier with the specific CarrierID | [optional]
|
1012
|
-
**description** | **String**| Only return Carriers that start with the specific Description | [optional]
|
1011
|
+
**carrier_id** | **String**| Only return Carrier with the specific CarrierID | [optional]
|
1012
|
+
**description** | **String**| Only return Carriers that start with the specific Description | [optional]
|
1013
1013
|
|
1014
1014
|
### Return type
|
1015
1015
|
|
@@ -1077,10 +1077,10 @@ Name | Type | Description | Notes
|
|
1077
1077
|
------------- | ------------- | ------------- | -------------
|
1078
1078
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
1079
1079
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
1080
|
-
**id** | **String**| Default is nil | [optional]
|
1081
|
-
**name** | **String**| Default is nil | [optional]
|
1082
|
-
**contact_filter** | **String**| Default is nil | [optional]
|
1083
|
-
**modified_since** | **String**| Default is nil | [optional]
|
1080
|
+
**id** | **String**| Default is nil | [optional]
|
1081
|
+
**name** | **String**| Default is nil | [optional]
|
1082
|
+
**contact_filter** | **String**| Default is nil | [optional]
|
1083
|
+
**modified_since** | **String**| Default is nil | [optional]
|
1084
1084
|
**include_deprecated** | **Boolean**| Default is false | [optional] [default to false]
|
1085
1085
|
**include_product_prices** | **Boolean**| Default is false | [optional] [default to false]
|
1086
1086
|
|
@@ -1147,9 +1147,9 @@ Name | Type | Description | Notes
|
|
1147
1147
|
------------- | ------------- | ------------- | -------------
|
1148
1148
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
1149
1149
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
1150
|
-
**id** | **String**| Default is nil | [optional]
|
1150
|
+
**id** | **String**| Default is nil | [optional]
|
1151
1151
|
**deprecated** | **Boolean**| Default is false | [optional] [default to false]
|
1152
|
-
**name** | **String**| Default is nil | [optional]
|
1152
|
+
**name** | **String**| Default is nil | [optional]
|
1153
1153
|
|
1154
1154
|
### Return type
|
1155
1155
|
|
@@ -1322,11 +1322,11 @@ Name | Type | Description | Notes
|
|
1322
1322
|
------------- | ------------- | ------------- | -------------
|
1323
1323
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
1324
1324
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
1325
|
-
**id** | **String**| Default is nil | [optional]
|
1326
|
-
**name** | **String**| Default is nil | [optional]
|
1327
|
-
**method** | **String**| Default is nil | [optional]
|
1328
|
-
**is_active** | **Boolean**| Default is nil | [optional]
|
1329
|
-
**is_default** | **Boolean**| Default is nil | [optional]
|
1325
|
+
**id** | **String**| Default is nil | [optional]
|
1326
|
+
**name** | **String**| Default is nil | [optional]
|
1327
|
+
**method** | **String**| Default is nil | [optional]
|
1328
|
+
**is_active** | **Boolean**| Default is nil | [optional]
|
1329
|
+
**is_default** | **Boolean**| Default is nil | [optional]
|
1330
1330
|
|
1331
1331
|
### Return type
|
1332
1332
|
|
@@ -1441,7 +1441,7 @@ end
|
|
1441
1441
|
|
1442
1442
|
Name | Type | Description | Notes
|
1443
1443
|
------------- | ------------- | ------------- | -------------
|
1444
|
-
**id** | **String**| Default is nil | [optional]
|
1444
|
+
**id** | **String**| Default is nil | [optional]
|
1445
1445
|
**combine_additional_charges** | **Boolean**| Show additional charges in 'Lines' array | [optional] [default to false]
|
1446
1446
|
**hide_inventory_movements** | **Boolean**| Hide inventory movements (Default = false) | [optional] [default to false]
|
1447
1447
|
**include_transactions** | **Boolean**| Show related transactions (Default = false) | [optional] [default to false]
|
@@ -1505,7 +1505,7 @@ end
|
|
1505
1505
|
|
1506
1506
|
Name | Type | Description | Notes
|
1507
1507
|
------------- | ------------- | ------------- | -------------
|
1508
|
-
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1508
|
+
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1509
1509
|
**combine_additional_charges** | **Boolean**| Show additional charges in 'Lines' array | [optional] [default to false]
|
1510
1510
|
**include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
|
1511
1511
|
|
@@ -1584,21 +1584,21 @@ Name | Type | Description | Notes
|
|
1584
1584
|
------------- | ------------- | ------------- | -------------
|
1585
1585
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
1586
1586
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
1587
|
-
**search** | **String**| Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber | [optional]
|
1588
|
-
**created_since** | **DateTime**| Only return sales created after specified date. Date must follow ISO 8601 format. | [optional]
|
1589
|
-
**updated_since** | **DateTime**| Only return sales changed after specified date. Date must follow ISO 8601 format. | [optional]
|
1590
|
-
**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]
|
1591
|
-
**quote_status** | **String**| Only return sales with specified quote status | [optional]
|
1592
|
-
**order_status** | **String**| Only return sales with specified order status | [optional]
|
1593
|
-
**combined_pick_status** | **String**| Only return sales with specified CombinedPickingStatus | [optional]
|
1594
|
-
**combined_pack_status** | **String**| Only return sales with specified CombinedPackingStatus | [optional]
|
1595
|
-
**combined_shipping_status** | **String**| Only return sales with specified CombinedShippingStatus | [optional]
|
1596
|
-
**combined_invoice_status** | **String**| Only return sales with specified CombinedInvoiceStatus | [optional]
|
1597
|
-
**credit_note_status** | **String**| Only return sales with specified credit note status | [optional]
|
1598
|
-
**external_id** | **String**| Only return sales with specified External ID | [optional]
|
1599
|
-
**status** | **String**| Default is nil | [optional]
|
1600
|
-
**ready_for_shipping** | **Boolean**| Only return sales with 'Authorised' pack and not 'Authorised' shipping | [optional]
|
1601
|
-
**order_location_id** | **String**| Only return sales with specified Order Location ID | [optional]
|
1587
|
+
**search** | **String**| Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber | [optional]
|
1588
|
+
**created_since** | **DateTime**| Only return sales created after specified date. Date must follow ISO 8601 format. | [optional]
|
1589
|
+
**updated_since** | **DateTime**| Only return sales changed after specified date. Date must follow ISO 8601 format. | [optional]
|
1590
|
+
**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]
|
1591
|
+
**quote_status** | **String**| Only return sales with specified quote status | [optional]
|
1592
|
+
**order_status** | **String**| Only return sales with specified order status | [optional]
|
1593
|
+
**combined_pick_status** | **String**| Only return sales with specified CombinedPickingStatus | [optional]
|
1594
|
+
**combined_pack_status** | **String**| Only return sales with specified CombinedPackingStatus | [optional]
|
1595
|
+
**combined_shipping_status** | **String**| Only return sales with specified CombinedShippingStatus | [optional]
|
1596
|
+
**combined_invoice_status** | **String**| Only return sales with specified CombinedInvoiceStatus | [optional]
|
1597
|
+
**credit_note_status** | **String**| Only return sales with specified credit note status | [optional]
|
1598
|
+
**external_id** | **String**| Only return sales with specified External ID | [optional]
|
1599
|
+
**status** | **String**| Default is nil | [optional]
|
1600
|
+
**ready_for_shipping** | **Boolean**| Only return sales with 'Authorised' pack and not 'Authorised' shipping | [optional]
|
1601
|
+
**order_location_id** | **String**| Only return sales with specified Order Location ID | [optional]
|
1602
1602
|
|
1603
1603
|
### Return type
|
1604
1604
|
|
@@ -1659,7 +1659,7 @@ end
|
|
1659
1659
|
|
1660
1660
|
Name | Type | Description | Notes
|
1661
1661
|
------------- | ------------- | ------------- | -------------
|
1662
|
-
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1662
|
+
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1663
1663
|
**combine_additional_charges** | **Boolean**| Show additional charges in 'Lines' array | [optional] [default to false]
|
1664
1664
|
**include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
|
1665
1665
|
|
@@ -1720,7 +1720,7 @@ end
|
|
1720
1720
|
|
1721
1721
|
Name | Type | Description | Notes
|
1722
1722
|
------------- | ------------- | ------------- | -------------
|
1723
|
-
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1723
|
+
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1724
1724
|
|
1725
1725
|
### Return type
|
1726
1726
|
|
@@ -1781,7 +1781,7 @@ end
|
|
1781
1781
|
|
1782
1782
|
Name | Type | Description | Notes
|
1783
1783
|
------------- | ------------- | ------------- | -------------
|
1784
|
-
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1784
|
+
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
1785
1785
|
**combine_additional_charges** | **Boolean**| Show additional charges in 'Lines' array | [optional] [default to false]
|
1786
1786
|
**include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
|
1787
1787
|
|
@@ -1851,12 +1851,12 @@ Name | Type | Description | Notes
|
|
1851
1851
|
------------- | ------------- | ------------- | -------------
|
1852
1852
|
**page** | **String**| Default is 1 | [optional] [default to '1']
|
1853
1853
|
**limit** | **String**| Default is 100 | [optional] [default to '100']
|
1854
|
-
**id** | **String**| Default is nil | [optional]
|
1855
|
-
**name** | **String**| Default is nil | [optional]
|
1856
|
-
**is_active** | **Boolean**| Default is nil | [optional]
|
1857
|
-
**is_tax_for_sale** | **Boolean**| Default is nil | [optional]
|
1858
|
-
**is_tax_for_purchase** | **Boolean**| Default is nil | [optional]
|
1859
|
-
**account** | **String**| Default is nil | [optional]
|
1854
|
+
**id** | **String**| Default is nil | [optional]
|
1855
|
+
**name** | **String**| Default is nil | [optional]
|
1856
|
+
**is_active** | **Boolean**| Default is nil | [optional]
|
1857
|
+
**is_tax_for_sale** | **Boolean**| Default is nil | [optional]
|
1858
|
+
**is_tax_for_purchase** | **Boolean**| Default is nil | [optional]
|
1859
|
+
**account** | **String**| Default is nil | [optional]
|
1860
1860
|
|
1861
1861
|
### Return type
|
1862
1862
|
|
@@ -1969,7 +1969,7 @@ end
|
|
1969
1969
|
|
1970
1970
|
Name | Type | Description | Notes
|
1971
1971
|
------------- | ------------- | ------------- | -------------
|
1972
|
-
**account** | [**Account**](Account.md)| an Account object with properties to update |
|
1972
|
+
**account** | [**Account**](Account.md)| an Account object with properties to update |
|
1973
1973
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
1974
1974
|
|
1975
1975
|
### Return type
|
@@ -2030,7 +2030,7 @@ end
|
|
2030
2030
|
|
2031
2031
|
Name | Type | Description | Notes
|
2032
2032
|
------------- | ------------- | ------------- | -------------
|
2033
|
-
**customer** | [**Customer**](Customer.md)| a customer object with properties to update |
|
2033
|
+
**customer** | [**Customer**](Customer.md)| a customer object with properties to update |
|
2034
2034
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
2035
2035
|
|
2036
2036
|
### Return type
|
@@ -2091,7 +2091,7 @@ end
|
|
2091
2091
|
|
2092
2092
|
Name | Type | Description | Notes
|
2093
2093
|
------------- | ------------- | ------------- | -------------
|
2094
|
-
**payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to update |
|
2094
|
+
**payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to update |
|
2095
2095
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
2096
2096
|
|
2097
2097
|
### Return type
|
@@ -2152,7 +2152,7 @@ end
|
|
2152
2152
|
|
2153
2153
|
Name | Type | Description | Notes
|
2154
2154
|
------------- | ------------- | ------------- | -------------
|
2155
|
-
**sale_payment** | [**SalePayment**](SalePayment.md)| a sale payment object with properties to update |
|
2155
|
+
**sale_payment** | [**SalePayment**](SalePayment.md)| a sale payment object with properties to update |
|
2156
2156
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
2157
2157
|
|
2158
2158
|
### Return type
|
@@ -2213,7 +2213,7 @@ end
|
|
2213
2213
|
|
2214
2214
|
Name | Type | Description | Notes
|
2215
2215
|
------------- | ------------- | ------------- | -------------
|
2216
|
-
**tax** | [**Tax**](Tax.md)| a tax object with properties to update |
|
2216
|
+
**tax** | [**Tax**](Tax.md)| a tax object with properties to update |
|
2217
2217
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
2218
2218
|
|
2219
2219
|
### Return type
|
@@ -2274,7 +2274,7 @@ end
|
|
2274
2274
|
|
2275
2275
|
Name | Type | Description | Notes
|
2276
2276
|
------------- | ------------- | ------------- | -------------
|
2277
|
-
**webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to update |
|
2277
|
+
**webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to update |
|
2278
2278
|
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
2279
2279
|
|
2280
2280
|
### Return type
|