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/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
data/docs/Location.md CHANGED
@@ -4,21 +4,21 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **String** | Required for `PUT` and `DELETE`, Ignored for `POST` operations | [optional]
8
- **name** | **String** | Location name | [optional]
7
+ **id** | **String** | Required for `PUT` and `DELETE`, Ignored for `POST` operations | [optional]
8
+ **name** | **String** | Location name | [optional]
9
9
  **is_default** | **Boolean** | Points that location is used as default | [optional] [default to false]
10
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]
11
+ **bins** | [**Array<Bin>**](Bin.md) | Array (ID, Name) with related Bins | [optional]
12
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]
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
22
  **is_shopfloor** | **Boolean** | Points that location is shopfloor | [optional] [default to false]
23
23
  **is_co_man** | **Boolean** | Points that location is location of co-manufacturer | [optional] [default to false]
24
24
  **is_staging** | **Boolean** | Points that location is staging. It is used only for Bins | [optional] [default to false]
data/docs/Locations.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
- **location_list** | [**Array<Location>**](Location.md) | Array of Locations | [optional]
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
 
data/docs/Me.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
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]
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
 
data/docs/MeContact.md CHANGED
@@ -4,14 +4,14 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
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]
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
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
data/docs/MeContacts.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
- **me_contacts_list** | [**Array<MeContact>**](MeContact.md) | Array of MeContacts | [optional]
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
 
data/docs/PaymentTerm.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
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]
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
11
  **is_active** | **Boolean** | Points that Payment Term is Active. `True` as default for POST. | [optional] [default to true]
12
12
  **is_default** | **Boolean** | Points that Payment Term is Default. `False` as default for POST. | [optional] [default to false]
13
13
 
data/docs/PaymentTerms.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
- **payment_term_list** | [**Array<PaymentTerm>**](PaymentTerm.md) | Array of PaymentTerms | [optional]
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
 
data/docs/PriceTier.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **code** | **Integer** | Code number of Price Tier | [optional]
8
- **name** | **String** | Price Tier name | [optional]
7
+ **code** | **Integer** | Code number of Price Tier | [optional]
8
+ **name** | **String** | Price Tier name | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
data/docs/PriceTiers.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **price_tiers** | [**Array<PriceTier>**](PriceTier.md) | Array of PriceTiers | [optional]
7
+ **price_tiers** | [**Array<PriceTier>**](PriceTier.md) | Array of PriceTiers | [optional]
8
8
 
9
9
  ## Code Sample
10
10
 
data/docs/Sale.md CHANGED
@@ -4,49 +4,49 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
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]
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
 
@@ -4,14 +4,14 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
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]
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