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.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/docs/Account.md +15 -15
  4. data/docs/Accounts.md +3 -3
  5. data/docs/Address.md +8 -8
  6. data/docs/AttachmentLine.md +5 -5
  7. data/docs/Bin.md +2 -2
  8. data/docs/Carrier.md +2 -2
  9. data/docs/Carriers.md +3 -3
  10. data/docs/Contact.md +9 -9
  11. data/docs/Customer.md +31 -31
  12. data/docs/Customers.md +3 -3
  13. data/docs/Error.md +2 -2
  14. data/docs/ExternalHeader.md +2 -2
  15. data/docs/InventoryApi.md +64 -64
  16. data/docs/Location.md +12 -12
  17. data/docs/Locations.md +3 -3
  18. data/docs/Me.md +7 -7
  19. data/docs/MeContact.md +8 -8
  20. data/docs/MeContacts.md +3 -3
  21. data/docs/PaymentTerm.md +4 -4
  22. data/docs/PaymentTerms.md +3 -3
  23. data/docs/PriceTier.md +2 -2
  24. data/docs/PriceTiers.md +1 -1
  25. data/docs/Sale.md +43 -43
  26. data/docs/SaleAdditionalCharge.md +8 -8
  27. data/docs/SaleInvoice.md +17 -17
  28. data/docs/SaleInvoiceAdditionalCharge.md +9 -9
  29. data/docs/SaleInvoiceDelete.md +1 -1
  30. data/docs/SaleInvoiceLine.md +12 -12
  31. data/docs/SaleInvoicePartial.md +12 -12
  32. data/docs/SaleInvoicePost.md +12 -12
  33. data/docs/SaleInvoices.md +2 -2
  34. data/docs/SaleItem.md +31 -31
  35. data/docs/SaleList.md +3 -3
  36. data/docs/SaleOrder.md +9 -9
  37. data/docs/SaleOrderLine.md +13 -13
  38. data/docs/SalePayment.md +14 -14
  39. data/docs/SalePaymentLine.md +7 -7
  40. data/docs/SaleQuote.md +8 -8
  41. data/docs/SaleQuoteLine.md +11 -11
  42. data/docs/ShippingAddress.md +11 -11
  43. data/docs/Success.md +1 -1
  44. data/docs/SupplierCustomerAddress.md +9 -9
  45. data/docs/Tax.md +5 -5
  46. data/docs/TaxComponent.md +3 -3
  47. data/docs/Taxes.md +3 -3
  48. data/docs/Webhook.md +10 -10
  49. data/docs/Webhooks.md +1 -1
  50. data/lib/dear-inventory-ruby/models/supplier_customer_address.rb +7 -7
  51. data/lib/dear-inventory-ruby/version.rb +1 -1
  52. data/spec/.DS_Store +0 -0
  53. data/spec/models/supplier_customer_address_spec.rb +1 -1
  54. metadata +3 -7
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
 
data/docs/SaleAdditionalCharge.md CHANGED
@@ -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
 
data/docs/SaleInvoice.md CHANGED
@@ -4,23 +4,23 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **task_id** | **String** | Identifier of sale Invoice task |
8
- **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
9
- **memo** | **String** | Additional information for Invoice. | [optional]
10
- **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
11
- **invoice_date** | **String** | Invoice Date. |
12
- **invoice_due_date** | **String** | Invoice Due Date. |
13
- **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
14
- **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
15
- **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
16
- **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
17
- **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
18
- **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
19
- **payments** | [**Array<SalePaymentLine>**](SalePaymentLine.md) | | [optional]
20
- **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges without taxes. | [optional]
21
- **tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges taxes. | [optional]
22
- **total** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges with taxes. | [optional]
23
- **paid** | **Float** | Decimal with up to 4 decimal places. Sum of payments. | [optional]
7
+ **task_id** | **String** | Identifier of sale Invoice task |
8
+ **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
9
+ **memo** | **String** | Additional information for Invoice. | [optional]
10
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
11
+ **invoice_date** | **String** | Invoice Date. |
12
+ **invoice_due_date** | **String** | Invoice Due Date. |
13
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
14
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
15
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
16
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
17
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
18
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
19
+ **payments** | [**Array<SalePaymentLine>**](SalePaymentLine.md) | | [optional]
20
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges without taxes. | [optional]
21
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges taxes. | [optional]
22
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges with taxes. | [optional]
23
+ **paid** | **Float** | Decimal with up to 4 decimal places. Sum of payments. | [optional]
24
24
 
25
25
  ## Code Sample
26
26
 
data/docs/SaleInvoiceAdditionalCharge.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **description** | **String** | Name of Service Product referenced by this Line |
8
- **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
9
- **price** | **Float** | Price per unit in Customer currency |
10
- **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
11
- **tax** | **Float** | Tax |
12
- **total** | **Float** | Line Total.For validation | [optional]
13
- **tax_rule** | **String** | Line Tax Rule name. |
14
- **account** | **String** | Revenue account |
15
- **comment** | **String** | Comment | [optional]
7
+ **description** | **String** | Name of Service Product referenced by this Line |
8
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
9
+ **price** | **Float** | Price per unit in Customer currency |
10
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
11
+ **tax** | **Float** | Tax |
12
+ **total** | **Float** | Line Total.For validation | [optional]
13
+ **tax_rule** | **String** | Line Tax Rule name. |
14
+ **account** | **String** | Revenue account |
15
+ **comment** | **String** | Comment | [optional]
16
16
 
17
17
  ## Code Sample
18
18
 
data/docs/SaleInvoiceDelete.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **task_id** | **String** | ID of Sale task to Void or Undo |
7
+ **task_id** | **String** | ID of Sale task to Void or Undo |
8
8
  **void** | **Boolean** | Default false | [optional] [default to false]
9
9
 
10
10
  ## Code Sample
data/docs/SaleInvoiceLine.md CHANGED
@@ -4,18 +4,18 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
- **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
- **name** | **String** | Product Name referenced by this Line |
10
- **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
- **price** | **Float** | Price per unit in Customer currency |
12
- **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
- **tax** | **Float** | Tax | [optional]
14
- **total** | **Float** | Line Total. For validation | [optional]
15
- **average_cost** | **Float** | Average product cost | [optional]
16
- **tax_rule** | **String** | Line Tax Rule name. | [optional]
17
- **account** | **String** | Revenue account | [optional]
18
- **comment** | **String** | Comment for this line | [optional]
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
+ **name** | **String** | Product Name referenced by this Line |
10
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
+ **price** | **Float** | Price per unit in Customer currency |
12
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
+ **tax** | **Float** | Tax | [optional]
14
+ **total** | **Float** | Line Total. For validation | [optional]
15
+ **average_cost** | **Float** | Average product cost | [optional]
16
+ **tax_rule** | **String** | Line Tax Rule name. | [optional]
17
+ **account** | **String** | Revenue account | [optional]
18
+ **comment** | **String** | Comment for this line | [optional]
19
19
 
20
20
  ## Code Sample
21
21
 
data/docs/SaleInvoicePartial.md CHANGED
@@ -4,19 +4,19 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **task_id** | **String** | Identifier of sale Invoice task |
7
+ **task_id** | **String** | Identifier of sale Invoice task |
8
8
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [optional] [default to false]
9
- **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
10
- **memo** | **String** | Additional information for Invoice. | [optional]
11
- **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
- **invoice_date** | **String** | Invoice Date. |
13
- **invoice_due_date** | **String** | Invoice Due Date. |
14
- **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
- **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
- **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
- **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
- **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
- **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
9
+ **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
10
+ **memo** | **String** | Additional information for Invoice. | [optional]
11
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
+ **invoice_date** | **String** | Invoice Date. |
13
+ **invoice_due_date** | **String** | Invoice Due Date. |
14
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
data/docs/SaleInvoicePost.md CHANGED
@@ -4,19 +4,19 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
8
- **task_id** | **String** | Identifier of sale Invoice task |
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **task_id** | **String** | Identifier of sale Invoice task |
9
9
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
10
- **memo** | **String** | Additional information for Invoice. | [optional]
11
- **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
- **invoice_date** | **String** | Invoice Date. |
13
- **invoice_due_date** | **String** | Invoice Due Date. |
14
- **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
- **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
- **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
- **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
- **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
- **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
10
+ **memo** | **String** | Additional information for Invoice. | [optional]
11
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
+ **invoice_date** | **String** | Invoice Date. |
13
+ **invoice_due_date** | **String** | Invoice Due Date. |
14
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
data/docs/SaleInvoices.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
8
- **invoices** | [**Array<SaleInvoicePartial>**](SaleInvoicePartial.md) | Array of Invoices | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **invoices** | [**Array<SaleInvoicePartial>**](SaleInvoicePartial.md) | Array of Invoices | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
data/docs/SaleItem.md CHANGED
@@ -4,37 +4,37 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale identifier | [optional]
8
- **order_number** | **String** | Sale Order number generated by DEAR | [optional]
9
- **status** | **String** | Current sale status. Possible values are values | [optional]
10
- **order_date** | **Date** | Date when Sale Order was created | [optional]
11
- **invoice_date** | **Date** | Date when Invoice was issued | [optional]
12
- **customer** | **String** | Name of the customer | [optional]
13
- **customer_id** | **String** | Customer Identifier | [optional]
14
- **invoice_number** | **String** | Invoice number generated by DEAR | [optional]
15
- **customer_reference** | **String** | Optional Customer Reference (typically customer Purchase order number) supplied by the customer for the sale | [optional]
16
- **invoice_amount** | **Float** | Total Invoice amount minus total Credit note amount in customer currency | [optional]
17
- **paid_amount** | **Float** | Total Paid amount minus Refunded amount in customer currency | [optional]
18
- **invoice_due_date** | **Date** | Date when invoice is due according to selected payment terms | [optional]
19
- **ship_by** | **Date** | Date when shipment is due | [optional]
20
- **base_currency** | **String** | 3 digit Base currency code (as configured in General Settings) | [optional]
21
- **customer_currency** | **String** | 3 digit Customer currency code | [optional]
22
- **credit_note_number** | **String** | Credit note number generated by DEAR. Is empty unless credit note is created | [optional]
23
- **updated** | **Date** | Date when the sale was last created/updated last time | [optional]
24
- **quote_status** | **String** | Sale Quote status. Possible Values are values | [optional]
25
- **order_status** | **String** | Sale Order status. Possible Values are values | [optional]
26
- **combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional]
27
- **combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional]
28
- **combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional]
29
- **ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional]
30
- **combined_invoice_status** | **String** | Invoice status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE, PAID | [optional]
31
- **credit_note_status** | **String** | Credit Note status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE | [optional]
32
- **combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional]
33
- **type** | **String** | Type of Sale. Possible Values are Simple Sale, Advanced Sale , Service Sale | [optional]
34
- **combined_tracking_numbers** | **String** | Tracking Numbers | [optional]
35
- **source_channel** | **String** | Source of the sale. read-only field | [optional]
36
- **external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional]
37
- **order_location_id** | **String** | Sale Order Location ID | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale identifier | [optional]
8
+ **order_number** | **String** | Sale Order number generated by DEAR | [optional]
9
+ **status** | **String** | Current sale status. Possible values are values | [optional]
10
+ **order_date** | **Date** | Date when Sale Order was created | [optional]
11
+ **invoice_date** | **Date** | Date when Invoice was issued | [optional]
12
+ **customer** | **String** | Name of the customer | [optional]
13
+ **customer_id** | **String** | Customer Identifier | [optional]
14
+ **invoice_number** | **String** | Invoice number generated by DEAR | [optional]
15
+ **customer_reference** | **String** | Optional Customer Reference (typically customer Purchase order number) supplied by the customer for the sale | [optional]
16
+ **invoice_amount** | **Float** | Total Invoice amount minus total Credit note amount in customer currency | [optional]
17
+ **paid_amount** | **Float** | Total Paid amount minus Refunded amount in customer currency | [optional]
18
+ **invoice_due_date** | **Date** | Date when invoice is due according to selected payment terms | [optional]
19
+ **ship_by** | **Date** | Date when shipment is due | [optional]
20
+ **base_currency** | **String** | 3 digit Base currency code (as configured in General Settings) | [optional]
21
+ **customer_currency** | **String** | 3 digit Customer currency code | [optional]
22
+ **credit_note_number** | **String** | Credit note number generated by DEAR. Is empty unless credit note is created | [optional]
23
+ **updated** | **Date** | Date when the sale was last created/updated last time | [optional]
24
+ **quote_status** | **String** | Sale Quote status. Possible Values are values | [optional]
25
+ **order_status** | **String** | Sale Order status. Possible Values are values | [optional]
26
+ **combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional]
27
+ **combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional]
28
+ **combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional]
29
+ **ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional]
30
+ **combined_invoice_status** | **String** | Invoice status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE, PAID | [optional]
31
+ **credit_note_status** | **String** | Credit Note status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE | [optional]
32
+ **combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional]
33
+ **type** | **String** | Type of Sale. Possible Values are Simple Sale, Advanced Sale , Service Sale | [optional]
34
+ **combined_tracking_numbers** | **String** | Tracking Numbers | [optional]
35
+ **source_channel** | **String** | Source of the sale. read-only field | [optional]
36
+ **external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional]
37
+ **order_location_id** | **String** | Sale Order Location ID | [optional]
38
38
 
39
39
  ## Code Sample
40
40
 
data/docs/SaleList.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total** | **Float** | Total | [optional]
8
- **page** | **Float** | Page | [optional]
9
- **sale_list** | [**Array<SaleItem>**](SaleItem.md) | Array of SaleItem | [optional]
7
+ **total** | **Float** | Total | [optional]
8
+ **page** | **Float** | Page | [optional]
9
+ **sale_list** | [**Array<SaleItem>**](SaleItem.md) | Array of SaleItem | [optional]
10
10
 
11
11
  ## Code Sample
12
12
 
data/docs/SaleOrder.md CHANGED
@@ -4,16 +4,16 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **sale_id** | **String** | Unique DEAR Sale ID |
8
- **sale_order_number** | **String** | Sale Order Number (auto-generated) | [optional]
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **sale_order_number** | **String** | Sale Order Number (auto-generated) | [optional]
9
9
  **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
10
- **memo** | **String** | Additional information for Order. |
11
- **status** | **String** | Order Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
12
- **lines** | [**Array<SaleOrderLine>**](SaleOrderLine.md) | | [optional]
13
- **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
14
- **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges without taxes. Not required for POST. |
15
- **tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges taxes. Not required for POST. |
16
- **total** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges with taxes. Not required for POST. |
10
+ **memo** | **String** | Additional information for Order. |
11
+ **status** | **String** | Order Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
12
+ **lines** | [**Array<SaleOrderLine>**](SaleOrderLine.md) | | [optional]
13
+ **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
14
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges without taxes. Not required for POST. |
15
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges taxes. Not required for POST. |
16
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges with taxes. Not required for POST. |
17
17
 
18
18
  ## Code Sample
19
19