@epilot/pricing-client 2.1.2 → 2.1.5
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.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +766 -72
- package/dist/openapi.json +511 -65
- package/package.json +2 -2
package/dist/openapi.json
CHANGED
|
@@ -122,6 +122,77 @@
|
|
|
122
122
|
"required": true,
|
|
123
123
|
"content": {
|
|
124
124
|
"application/json": {
|
|
125
|
+
"examples": {
|
|
126
|
+
"Order with Simple Prices": {
|
|
127
|
+
"value": {
|
|
128
|
+
"status": "quote",
|
|
129
|
+
"source_type": "manual",
|
|
130
|
+
"expires_at": "2022-06-30T16:17:00.000Z",
|
|
131
|
+
"line_items": [
|
|
132
|
+
{
|
|
133
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
134
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
135
|
+
"quantity": 16
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
139
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
140
|
+
"quantity": 4
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
144
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
145
|
+
"quantity": 1
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
149
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
150
|
+
"quantity": 1
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"currency": "EUR",
|
|
154
|
+
"payment_method": [
|
|
155
|
+
{
|
|
156
|
+
"type": "IBAN",
|
|
157
|
+
"details": {}
|
|
158
|
+
}
|
|
159
|
+
],
|
|
160
|
+
"billing_contact": {
|
|
161
|
+
"$relation": [
|
|
162
|
+
{
|
|
163
|
+
"entity_id": "1834a54e-b68f-4f7f-a98a-fe16f11bc2a5",
|
|
164
|
+
"_tags": []
|
|
165
|
+
}
|
|
166
|
+
]
|
|
167
|
+
},
|
|
168
|
+
"billing_first_name": "Joao",
|
|
169
|
+
"billing_last_name": "Pinho",
|
|
170
|
+
"billing_email": "j.pinho@epilot.cloud",
|
|
171
|
+
"billing_company_name": "epilot cloud",
|
|
172
|
+
"billing_address": [
|
|
173
|
+
{
|
|
174
|
+
"_tags": [],
|
|
175
|
+
"street": "Im Media Park",
|
|
176
|
+
"street_number": "8a",
|
|
177
|
+
"postal_code": "52000",
|
|
178
|
+
"city": "Cologne",
|
|
179
|
+
"country": "DE",
|
|
180
|
+
"additional_info": ""
|
|
181
|
+
}
|
|
182
|
+
],
|
|
183
|
+
"delivery_address": [],
|
|
184
|
+
"dates": [
|
|
185
|
+
{
|
|
186
|
+
"_tags": [
|
|
187
|
+
"Instalation Date"
|
|
188
|
+
],
|
|
189
|
+
"dates": "",
|
|
190
|
+
"value": "2022-06-30T16:29:00.000Z"
|
|
191
|
+
}
|
|
192
|
+
]
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
},
|
|
125
196
|
"schema": {
|
|
126
197
|
"$ref": "#/components/schemas/OrderPayload"
|
|
127
198
|
}
|
|
@@ -169,7 +240,7 @@
|
|
|
169
240
|
"type": "string"
|
|
170
241
|
},
|
|
171
242
|
"required": true,
|
|
172
|
-
"example": "
|
|
243
|
+
"example": "9d4602d3-03be-4d85-86b2-f3c6555fc606"
|
|
173
244
|
}
|
|
174
245
|
],
|
|
175
246
|
"requestBody": {
|
|
@@ -178,6 +249,77 @@
|
|
|
178
249
|
"application/json": {
|
|
179
250
|
"schema": {
|
|
180
251
|
"$ref": "#/components/schemas/OrderPayload"
|
|
252
|
+
},
|
|
253
|
+
"examples": {
|
|
254
|
+
"Order with Simple Prices": {
|
|
255
|
+
"value": {
|
|
256
|
+
"status": "quote",
|
|
257
|
+
"source_type": "manual",
|
|
258
|
+
"expires_at": "2022-06-30T16:17:00.000Z",
|
|
259
|
+
"line_items": [
|
|
260
|
+
{
|
|
261
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
262
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
263
|
+
"quantity": 16
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
267
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
268
|
+
"quantity": 4
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
272
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
273
|
+
"quantity": 1
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
|
|
277
|
+
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
278
|
+
"quantity": 1
|
|
279
|
+
}
|
|
280
|
+
],
|
|
281
|
+
"currency": "EUR",
|
|
282
|
+
"payment_method": [
|
|
283
|
+
{
|
|
284
|
+
"type": "IBAN",
|
|
285
|
+
"details": {}
|
|
286
|
+
}
|
|
287
|
+
],
|
|
288
|
+
"billing_contact": {
|
|
289
|
+
"$relation": [
|
|
290
|
+
{
|
|
291
|
+
"entity_id": "1834a54e-b68f-4f7f-a98a-fe16f11bc2a5",
|
|
292
|
+
"_tags": []
|
|
293
|
+
}
|
|
294
|
+
]
|
|
295
|
+
},
|
|
296
|
+
"billing_first_name": "Joao",
|
|
297
|
+
"billing_last_name": "Pinho",
|
|
298
|
+
"billing_email": "j.pinho@epilot.cloud",
|
|
299
|
+
"billing_company_name": "epilot cloud",
|
|
300
|
+
"billing_address": [
|
|
301
|
+
{
|
|
302
|
+
"_tags": [],
|
|
303
|
+
"street": "Im Media Park",
|
|
304
|
+
"street_number": "8a",
|
|
305
|
+
"postal_code": "52000",
|
|
306
|
+
"city": "Cologne",
|
|
307
|
+
"country": "DE",
|
|
308
|
+
"additional_info": ""
|
|
309
|
+
}
|
|
310
|
+
],
|
|
311
|
+
"delivery_address": [],
|
|
312
|
+
"dates": [
|
|
313
|
+
{
|
|
314
|
+
"_tags": [
|
|
315
|
+
"Instalation Date"
|
|
316
|
+
],
|
|
317
|
+
"dates": "",
|
|
318
|
+
"value": "2022-06-30T16:29:00.000Z"
|
|
319
|
+
}
|
|
320
|
+
]
|
|
321
|
+
}
|
|
322
|
+
}
|
|
181
323
|
}
|
|
182
324
|
}
|
|
183
325
|
}
|
|
@@ -234,10 +376,7 @@
|
|
|
234
376
|
"$ref": "#/components/schemas/CheckoutCart"
|
|
235
377
|
},
|
|
236
378
|
"examples": {
|
|
237
|
-
"Checkout with a
|
|
238
|
-
"$ref": "#/components/examples/checkout-with-cart-id"
|
|
239
|
-
},
|
|
240
|
-
"Fast Checkout with a transient Cart": {
|
|
379
|
+
"Checkout with a transient Cart": {
|
|
241
380
|
"$ref": "#/components/examples/checkout-with-transient-cart"
|
|
242
381
|
}
|
|
243
382
|
}
|
|
@@ -562,6 +701,14 @@
|
|
|
562
701
|
"message": {
|
|
563
702
|
"type": "string",
|
|
564
703
|
"description": "Error message"
|
|
704
|
+
},
|
|
705
|
+
"status": {
|
|
706
|
+
"type": "number",
|
|
707
|
+
"description": "The HTTP status code"
|
|
708
|
+
},
|
|
709
|
+
"cause": {
|
|
710
|
+
"type": "string",
|
|
711
|
+
"description": "The cause of the error (visible for bad requests - http 400)"
|
|
565
712
|
}
|
|
566
713
|
}
|
|
567
714
|
},
|
|
@@ -1090,6 +1237,10 @@
|
|
|
1090
1237
|
"type": "boolean",
|
|
1091
1238
|
"description": "Whether the price can be used for new purchases."
|
|
1092
1239
|
},
|
|
1240
|
+
"is_composite_price": {
|
|
1241
|
+
"description": "The flag for prices that contain price components.",
|
|
1242
|
+
"type": "boolean"
|
|
1243
|
+
},
|
|
1093
1244
|
"billing_scheme": {
|
|
1094
1245
|
"type": "string",
|
|
1095
1246
|
"description": "Describes how to compute the price per period. Either `per_unit` or `tiered`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.\n\n⚠️ Tiered pricing is **not supported** yet.\n",
|
|
@@ -1111,16 +1262,26 @@
|
|
|
1111
1262
|
]
|
|
1112
1263
|
},
|
|
1113
1264
|
"tax": {
|
|
1114
|
-
"type": "object",
|
|
1115
1265
|
"description": "The default tax rate applied to the price",
|
|
1116
|
-
"
|
|
1117
|
-
|
|
1266
|
+
"oneOf": [
|
|
1267
|
+
{
|
|
1268
|
+
"type": "object",
|
|
1269
|
+
"properties": {
|
|
1270
|
+
"$relation": {
|
|
1271
|
+
"type": "array",
|
|
1272
|
+
"items": {
|
|
1273
|
+
"$ref": "#/components/schemas/EntityRelation"
|
|
1274
|
+
}
|
|
1275
|
+
}
|
|
1276
|
+
}
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1118
1279
|
"type": "array",
|
|
1119
1280
|
"items": {
|
|
1120
|
-
"$ref": "#/components/schemas/
|
|
1281
|
+
"$ref": "#/components/schemas/Tax"
|
|
1121
1282
|
}
|
|
1122
1283
|
}
|
|
1123
|
-
|
|
1284
|
+
]
|
|
1124
1285
|
},
|
|
1125
1286
|
"tax_behavior": {
|
|
1126
1287
|
"type": "string",
|
|
@@ -1277,16 +1438,26 @@
|
|
|
1277
1438
|
"description": "A brief description of the price."
|
|
1278
1439
|
},
|
|
1279
1440
|
"price_components": {
|
|
1280
|
-
"type": "object",
|
|
1281
1441
|
"description": "A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.",
|
|
1282
|
-
"
|
|
1283
|
-
|
|
1442
|
+
"oneOf": [
|
|
1443
|
+
{
|
|
1284
1444
|
"type": "array",
|
|
1285
1445
|
"items": {
|
|
1286
|
-
"$ref": "#/components/schemas/
|
|
1446
|
+
"$ref": "#/components/schemas/Price"
|
|
1447
|
+
}
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"type": "object",
|
|
1451
|
+
"properties": {
|
|
1452
|
+
"$relation": {
|
|
1453
|
+
"type": "array",
|
|
1454
|
+
"items": {
|
|
1455
|
+
"$ref": "#/components/schemas/PriceComponentRelation"
|
|
1456
|
+
}
|
|
1457
|
+
}
|
|
1287
1458
|
}
|
|
1288
1459
|
}
|
|
1289
|
-
|
|
1460
|
+
]
|
|
1290
1461
|
},
|
|
1291
1462
|
"unit_amount_currency": {
|
|
1292
1463
|
"description": "Three-letter ISO currency code, in lowercase.",
|
|
@@ -1296,6 +1467,10 @@
|
|
|
1296
1467
|
}
|
|
1297
1468
|
]
|
|
1298
1469
|
},
|
|
1470
|
+
"is_composite_price": {
|
|
1471
|
+
"description": "The flag for prices that contain price components.",
|
|
1472
|
+
"type": "boolean"
|
|
1473
|
+
},
|
|
1299
1474
|
"_created_at": {
|
|
1300
1475
|
"description": "The price creation date",
|
|
1301
1476
|
"type": "string"
|
|
@@ -1336,9 +1511,6 @@
|
|
|
1336
1511
|
"description": "By default, the quantity is set to 1, when greater than 1 this value is used as a multiplicative factor.\nE.g: 16 x Solar Modules - Premium price.\n",
|
|
1337
1512
|
"type": "number"
|
|
1338
1513
|
},
|
|
1339
|
-
"item": {
|
|
1340
|
-
"$ref": "#/components/schemas/Price"
|
|
1341
|
-
},
|
|
1342
1514
|
"_tags": {
|
|
1343
1515
|
"type": "array",
|
|
1344
1516
|
"description": "An arbitrary set of tags attached to the composite price - component relation",
|
|
@@ -1660,8 +1832,8 @@
|
|
|
1660
1832
|
]
|
|
1661
1833
|
}
|
|
1662
1834
|
},
|
|
1663
|
-
"
|
|
1664
|
-
"description": "Represents a valid price item from a client.",
|
|
1835
|
+
"BasePriceItemDto": {
|
|
1836
|
+
"description": "Represents a valid base price item from a client.",
|
|
1665
1837
|
"type": "object",
|
|
1666
1838
|
"properties": {
|
|
1667
1839
|
"metadata": {
|
|
@@ -1683,14 +1855,6 @@
|
|
|
1683
1855
|
"type": "string",
|
|
1684
1856
|
"description": "The id of the price."
|
|
1685
1857
|
},
|
|
1686
|
-
"unit_amount": {
|
|
1687
|
-
"type": "integer",
|
|
1688
|
-
"description": "The unit amount value"
|
|
1689
|
-
},
|
|
1690
|
-
"unit_amount_decimal": {
|
|
1691
|
-
"description": "The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.",
|
|
1692
|
-
"type": "string"
|
|
1693
|
-
},
|
|
1694
1858
|
"taxes": {
|
|
1695
1859
|
"type": "array",
|
|
1696
1860
|
"description": "The taxes applied to the price item.",
|
|
@@ -1715,23 +1879,59 @@
|
|
|
1715
1879
|
]
|
|
1716
1880
|
}
|
|
1717
1881
|
},
|
|
1882
|
+
"is_composite_price": {
|
|
1883
|
+
"description": "The flag for prices that contain price components.",
|
|
1884
|
+
"type": "boolean"
|
|
1885
|
+
},
|
|
1886
|
+
"_product": {
|
|
1887
|
+
"description": "The snapshot of the product.",
|
|
1888
|
+
"allOf": [
|
|
1889
|
+
{
|
|
1890
|
+
"$ref": "#/components/schemas/Product"
|
|
1891
|
+
}
|
|
1892
|
+
]
|
|
1893
|
+
}
|
|
1894
|
+
}
|
|
1895
|
+
},
|
|
1896
|
+
"PriceItemDto": {
|
|
1897
|
+
"allOf": [
|
|
1898
|
+
{
|
|
1899
|
+
"$ref": "#/components/schemas/BasePriceItemDto"
|
|
1900
|
+
}
|
|
1901
|
+
],
|
|
1902
|
+
"description": "Represents a price input to the pricing library.",
|
|
1903
|
+
"type": "object",
|
|
1904
|
+
"properties": {
|
|
1905
|
+
"type": {
|
|
1906
|
+
"type": "string",
|
|
1907
|
+
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
1908
|
+
"enum": [
|
|
1909
|
+
"one_time",
|
|
1910
|
+
"recurring"
|
|
1911
|
+
]
|
|
1912
|
+
},
|
|
1913
|
+
"unit_amount": {
|
|
1914
|
+
"type": "integer",
|
|
1915
|
+
"description": "The unit amount value"
|
|
1916
|
+
},
|
|
1917
|
+
"unit_amount_decimal": {
|
|
1918
|
+
"description": "The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.",
|
|
1919
|
+
"type": "string"
|
|
1920
|
+
},
|
|
1718
1921
|
"_price": {
|
|
1719
|
-
"
|
|
1922
|
+
"description": "The snapshot of the price linked to the price item.",
|
|
1923
|
+
"allOf": [
|
|
1720
1924
|
{
|
|
1721
1925
|
"$ref": "#/components/schemas/Price"
|
|
1722
1926
|
}
|
|
1723
1927
|
]
|
|
1724
|
-
},
|
|
1725
|
-
"_product": {
|
|
1726
|
-
"description": "The product linked to the price item.",
|
|
1727
|
-
"$ref": "#/components/schemas/Product"
|
|
1728
1928
|
}
|
|
1729
1929
|
}
|
|
1730
1930
|
},
|
|
1731
1931
|
"CompositePriceItemDto": {
|
|
1732
1932
|
"allOf": [
|
|
1733
1933
|
{
|
|
1734
|
-
"$ref": "#/components/schemas/
|
|
1934
|
+
"$ref": "#/components/schemas/BasePriceItemDto"
|
|
1735
1935
|
}
|
|
1736
1936
|
],
|
|
1737
1937
|
"description": "Represents a composite price input to the pricing library.",
|
|
@@ -1745,11 +1945,7 @@
|
|
|
1745
1945
|
}
|
|
1746
1946
|
},
|
|
1747
1947
|
"_price": {
|
|
1748
|
-
"
|
|
1749
|
-
{
|
|
1750
|
-
"$ref": "#/components/schemas/CompositePrice"
|
|
1751
|
-
}
|
|
1752
|
-
]
|
|
1948
|
+
"$ref": "#/components/schemas/CompositePrice"
|
|
1753
1949
|
}
|
|
1754
1950
|
}
|
|
1755
1951
|
},
|
|
@@ -1759,15 +1955,11 @@
|
|
|
1759
1955
|
"properties": {
|
|
1760
1956
|
"rate": {
|
|
1761
1957
|
"type": "string",
|
|
1762
|
-
"
|
|
1958
|
+
"deprecated": true,
|
|
1959
|
+
"description": "The deprecated tax rate applied.\nThis field has been deprecated in favor of the new Tax Management. You should use the new tax fields pointing to a proper tax entity.\n"
|
|
1763
1960
|
},
|
|
1764
1961
|
"tax": {
|
|
1765
|
-
"
|
|
1766
|
-
"oneOf": [
|
|
1767
|
-
{
|
|
1768
|
-
"$ref": "#/components/schemas/Tax"
|
|
1769
|
-
}
|
|
1770
|
-
]
|
|
1962
|
+
"$ref": "#/components/schemas/Tax"
|
|
1771
1963
|
}
|
|
1772
1964
|
}
|
|
1773
1965
|
},
|
|
@@ -1829,7 +2021,6 @@
|
|
|
1829
2021
|
}
|
|
1830
2022
|
},
|
|
1831
2023
|
"required": [
|
|
1832
|
-
"type",
|
|
1833
2024
|
"amount_subtotal",
|
|
1834
2025
|
"amount_total"
|
|
1835
2026
|
]
|
|
@@ -1989,7 +2180,7 @@
|
|
|
1989
2180
|
"description": "Tracks a set of product prices, quantities, (discounts) and taxes.",
|
|
1990
2181
|
"type": "array",
|
|
1991
2182
|
"items": {
|
|
1992
|
-
"
|
|
2183
|
+
"anyOf": [
|
|
1993
2184
|
{
|
|
1994
2185
|
"$ref": "#/components/schemas/PriceItem"
|
|
1995
2186
|
},
|
|
@@ -2002,7 +2193,7 @@
|
|
|
2002
2193
|
"CompositePriceItem": {
|
|
2003
2194
|
"allOf": [
|
|
2004
2195
|
{
|
|
2005
|
-
"$ref": "#/components/schemas/
|
|
2196
|
+
"$ref": "#/components/schemas/BasePriceItem"
|
|
2006
2197
|
}
|
|
2007
2198
|
],
|
|
2008
2199
|
"description": "Represents a composite price input to the pricing library.",
|
|
@@ -2017,7 +2208,7 @@
|
|
|
2017
2208
|
}
|
|
2018
2209
|
}
|
|
2019
2210
|
},
|
|
2020
|
-
"
|
|
2211
|
+
"BasePriceItem": {
|
|
2021
2212
|
"description": "Represents a price item",
|
|
2022
2213
|
"type": "object",
|
|
2023
2214
|
"example": {
|
|
@@ -2091,12 +2282,7 @@
|
|
|
2091
2282
|
]
|
|
2092
2283
|
},
|
|
2093
2284
|
"_product": {
|
|
2094
|
-
"
|
|
2095
|
-
"anyOf": [
|
|
2096
|
-
{
|
|
2097
|
-
"$ref": "#/components/schemas/Product"
|
|
2098
|
-
}
|
|
2099
|
-
]
|
|
2285
|
+
"$ref": "#/components/schemas/Product"
|
|
2100
2286
|
},
|
|
2101
2287
|
"taxes": {
|
|
2102
2288
|
"type": "array",
|
|
@@ -2124,6 +2310,28 @@
|
|
|
2124
2310
|
}
|
|
2125
2311
|
}
|
|
2126
2312
|
},
|
|
2313
|
+
"PriceItem": {
|
|
2314
|
+
"allOf": [
|
|
2315
|
+
{
|
|
2316
|
+
"$ref": "#/components/schemas/BasePriceItem"
|
|
2317
|
+
}
|
|
2318
|
+
],
|
|
2319
|
+
"description": "Represents a price item",
|
|
2320
|
+
"type": "object",
|
|
2321
|
+
"example": {
|
|
2322
|
+
"$ref": "#/components/examples/price-item"
|
|
2323
|
+
},
|
|
2324
|
+
"properties": {
|
|
2325
|
+
"type": {
|
|
2326
|
+
"type": "string",
|
|
2327
|
+
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
2328
|
+
"enum": [
|
|
2329
|
+
"one_time",
|
|
2330
|
+
"recurring"
|
|
2331
|
+
]
|
|
2332
|
+
}
|
|
2333
|
+
}
|
|
2334
|
+
},
|
|
2127
2335
|
"TaxAmount": {
|
|
2128
2336
|
"type": "object",
|
|
2129
2337
|
"description": "A tax amount associated with a specific tax rate.",
|
|
@@ -2135,7 +2343,14 @@
|
|
|
2135
2343
|
},
|
|
2136
2344
|
"rate": {
|
|
2137
2345
|
"type": "string",
|
|
2138
|
-
"description": "The tax rate applied."
|
|
2346
|
+
"description": "The tax rate applied. With the release of the tax management feature this field is being deprecated in favor of the tax field.",
|
|
2347
|
+
"deprecated": true
|
|
2348
|
+
},
|
|
2349
|
+
"rateValue": {
|
|
2350
|
+
"type": "number",
|
|
2351
|
+
"description": "The tax rate value applied (represented as an integer percentage, e.g, 19 or 7).\nWith the release of the tax management feature this field is being deprecated in favor of the tax field.\n",
|
|
2352
|
+
"example": 19,
|
|
2353
|
+
"deprecated": true
|
|
2139
2354
|
},
|
|
2140
2355
|
"tax": {
|
|
2141
2356
|
"description": "The tax applied.",
|
|
@@ -2147,6 +2362,30 @@
|
|
|
2147
2362
|
}
|
|
2148
2363
|
}
|
|
2149
2364
|
},
|
|
2365
|
+
"TaxAmountBreakdown": {
|
|
2366
|
+
"type": "object",
|
|
2367
|
+
"description": "A tax amount associated with a specific tax rate.",
|
|
2368
|
+
"readOnly": true,
|
|
2369
|
+
"properties": {
|
|
2370
|
+
"amount": {
|
|
2371
|
+
"type": "integer",
|
|
2372
|
+
"description": "The tax amount."
|
|
2373
|
+
},
|
|
2374
|
+
"rate": {
|
|
2375
|
+
"type": "string",
|
|
2376
|
+
"description": "The tax rate applied. With the release of the tax manager feature this field is being deprecated in favor of the tax field.",
|
|
2377
|
+
"deprecated": true
|
|
2378
|
+
},
|
|
2379
|
+
"rateValue": {
|
|
2380
|
+
"type": "number",
|
|
2381
|
+
"description": "The tax rate value applied. With the release of the tax manager feature this field is being deprecated in favor of the tax field.",
|
|
2382
|
+
"deprecated": true
|
|
2383
|
+
},
|
|
2384
|
+
"tax": {
|
|
2385
|
+
"$ref": "#/components/schemas/TaxBreakdownInfo"
|
|
2386
|
+
}
|
|
2387
|
+
}
|
|
2388
|
+
},
|
|
2150
2389
|
"RecurrenceAmount": {
|
|
2151
2390
|
"type": "object",
|
|
2152
2391
|
"description": "An amount associated with a specific recurrence.",
|
|
@@ -2174,7 +2413,6 @@
|
|
|
2174
2413
|
}
|
|
2175
2414
|
},
|
|
2176
2415
|
"required": [
|
|
2177
|
-
"type",
|
|
2178
2416
|
"amount_subtotal",
|
|
2179
2417
|
"amount_total"
|
|
2180
2418
|
]
|
|
@@ -2202,7 +2440,7 @@
|
|
|
2202
2440
|
"items": {
|
|
2203
2441
|
"oneOf": [
|
|
2204
2442
|
{
|
|
2205
|
-
"$ref": "#/components/schemas/
|
|
2443
|
+
"$ref": "#/components/schemas/TaxAmountBreakdown"
|
|
2206
2444
|
}
|
|
2207
2445
|
]
|
|
2208
2446
|
}
|
|
@@ -2509,6 +2747,62 @@
|
|
|
2509
2747
|
"filename"
|
|
2510
2748
|
]
|
|
2511
2749
|
},
|
|
2750
|
+
"EntityId": {
|
|
2751
|
+
"type": "string",
|
|
2752
|
+
"format": "uuid"
|
|
2753
|
+
},
|
|
2754
|
+
"EntityItem": {
|
|
2755
|
+
"type": "object",
|
|
2756
|
+
"properties": {
|
|
2757
|
+
"_id": {
|
|
2758
|
+
"$ref": "#/components/schemas/EntityId"
|
|
2759
|
+
},
|
|
2760
|
+
"_title": {
|
|
2761
|
+
"type": "string",
|
|
2762
|
+
"description": "Title of entity"
|
|
2763
|
+
},
|
|
2764
|
+
"_org": {
|
|
2765
|
+
"type": "string",
|
|
2766
|
+
"description": "Organization Id the entity belongs to"
|
|
2767
|
+
},
|
|
2768
|
+
"_schema": {
|
|
2769
|
+
"type": "string"
|
|
2770
|
+
},
|
|
2771
|
+
"_tags": {
|
|
2772
|
+
"type": "array",
|
|
2773
|
+
"items": {
|
|
2774
|
+
"type": "string"
|
|
2775
|
+
}
|
|
2776
|
+
},
|
|
2777
|
+
"_created_at": {
|
|
2778
|
+
"type": "string",
|
|
2779
|
+
"format": "date-time"
|
|
2780
|
+
},
|
|
2781
|
+
"_updated_at": {
|
|
2782
|
+
"type": "string",
|
|
2783
|
+
"format": "date-time"
|
|
2784
|
+
}
|
|
2785
|
+
},
|
|
2786
|
+
"required": [
|
|
2787
|
+
"_id",
|
|
2788
|
+
"_title",
|
|
2789
|
+
"_org",
|
|
2790
|
+
"_schema",
|
|
2791
|
+
"_created_at",
|
|
2792
|
+
"_updated_at"
|
|
2793
|
+
],
|
|
2794
|
+
"example": {
|
|
2795
|
+
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
2796
|
+
"_org": "123",
|
|
2797
|
+
"_schema": "contact",
|
|
2798
|
+
"_tags": [
|
|
2799
|
+
"example",
|
|
2800
|
+
"mock"
|
|
2801
|
+
],
|
|
2802
|
+
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
2803
|
+
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
2804
|
+
}
|
|
2805
|
+
},
|
|
2512
2806
|
"EntityRelation": {
|
|
2513
2807
|
"type": "object",
|
|
2514
2808
|
"additionalProperties": true,
|
|
@@ -2531,9 +2825,43 @@
|
|
|
2531
2825
|
"required": [
|
|
2532
2826
|
"type",
|
|
2533
2827
|
"rate",
|
|
2534
|
-
"behavior"
|
|
2828
|
+
"behavior",
|
|
2829
|
+
"_id",
|
|
2830
|
+
"_title",
|
|
2831
|
+
"_org",
|
|
2832
|
+
"_schema",
|
|
2833
|
+
"_created_at",
|
|
2834
|
+
"_updated_at"
|
|
2535
2835
|
],
|
|
2536
2836
|
"properties": {
|
|
2837
|
+
"_id": {
|
|
2838
|
+
"$ref": "#/components/schemas/EntityId"
|
|
2839
|
+
},
|
|
2840
|
+
"_title": {
|
|
2841
|
+
"type": "string",
|
|
2842
|
+
"description": "Title of entity"
|
|
2843
|
+
},
|
|
2844
|
+
"_org": {
|
|
2845
|
+
"type": "string",
|
|
2846
|
+
"description": "Organization Id the entity belongs to"
|
|
2847
|
+
},
|
|
2848
|
+
"_schema": {
|
|
2849
|
+
"type": "string"
|
|
2850
|
+
},
|
|
2851
|
+
"_tags": {
|
|
2852
|
+
"type": "array",
|
|
2853
|
+
"items": {
|
|
2854
|
+
"type": "string"
|
|
2855
|
+
}
|
|
2856
|
+
},
|
|
2857
|
+
"_created_at": {
|
|
2858
|
+
"type": "string",
|
|
2859
|
+
"format": "date-time"
|
|
2860
|
+
},
|
|
2861
|
+
"_updated_at": {
|
|
2862
|
+
"type": "string",
|
|
2863
|
+
"format": "date-time"
|
|
2864
|
+
},
|
|
2537
2865
|
"type": {
|
|
2538
2866
|
"type": "string",
|
|
2539
2867
|
"enum": [
|
|
@@ -2552,7 +2880,9 @@
|
|
|
2552
2880
|
"type": "string",
|
|
2553
2881
|
"enum": [
|
|
2554
2882
|
"Exclusive",
|
|
2555
|
-
"Inclusive"
|
|
2883
|
+
"Inclusive",
|
|
2884
|
+
"exclusive",
|
|
2885
|
+
"inclusive"
|
|
2556
2886
|
]
|
|
2557
2887
|
},
|
|
2558
2888
|
"active": {
|
|
@@ -2564,6 +2894,42 @@
|
|
|
2564
2894
|
"region_label": {
|
|
2565
2895
|
"type": "string"
|
|
2566
2896
|
}
|
|
2897
|
+
},
|
|
2898
|
+
"example": {
|
|
2899
|
+
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
2900
|
+
"type": "VAT",
|
|
2901
|
+
"description": "Tax description",
|
|
2902
|
+
"behavior": "Exclusive",
|
|
2903
|
+
"active": "true",
|
|
2904
|
+
"region": "DE",
|
|
2905
|
+
"region_label": "Germany",
|
|
2906
|
+
"_org": "123",
|
|
2907
|
+
"_schema": "tax",
|
|
2908
|
+
"_tags": [
|
|
2909
|
+
"example",
|
|
2910
|
+
"mock"
|
|
2911
|
+
],
|
|
2912
|
+
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
2913
|
+
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
2914
|
+
}
|
|
2915
|
+
},
|
|
2916
|
+
"TaxBreakdownInfo": {
|
|
2917
|
+
"type": "object",
|
|
2918
|
+
"properties": {
|
|
2919
|
+
"rate": {
|
|
2920
|
+
"type": "number"
|
|
2921
|
+
},
|
|
2922
|
+
"type": {
|
|
2923
|
+
"type": "string",
|
|
2924
|
+
"enum": [
|
|
2925
|
+
"VAT",
|
|
2926
|
+
"GST",
|
|
2927
|
+
"Custom"
|
|
2928
|
+
]
|
|
2929
|
+
},
|
|
2930
|
+
"_id": {
|
|
2931
|
+
"type": "string"
|
|
2932
|
+
}
|
|
2567
2933
|
}
|
|
2568
2934
|
}
|
|
2569
2935
|
},
|
|
@@ -3284,6 +3650,86 @@
|
|
|
3284
3650
|
"_updated_at": "2022-06-03T16:29:46.303Z"
|
|
3285
3651
|
}
|
|
3286
3652
|
},
|
|
3653
|
+
"order-with-simple-prices-request": {
|
|
3654
|
+
"value": {
|
|
3655
|
+
"order_number": "OR 2022/742701",
|
|
3656
|
+
"status": "quote",
|
|
3657
|
+
"source": {
|
|
3658
|
+
"title": "manual",
|
|
3659
|
+
"href": null
|
|
3660
|
+
},
|
|
3661
|
+
"source_type": "manual",
|
|
3662
|
+
"_schema": "order",
|
|
3663
|
+
"_title": "OR 2022/742701",
|
|
3664
|
+
"expires_at": "2022-06-30T16:17:00.000Z",
|
|
3665
|
+
"line_items": [
|
|
3666
|
+
{
|
|
3667
|
+
"price_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
|
|
3668
|
+
"product_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
|
|
3669
|
+
"quantity": 16
|
|
3670
|
+
},
|
|
3671
|
+
{
|
|
3672
|
+
"price_id": "146aa2cc-f267-4d5e-bda4-cbe2669b7741",
|
|
3673
|
+
"product_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
|
|
3674
|
+
"quantity": 4
|
|
3675
|
+
},
|
|
3676
|
+
{
|
|
3677
|
+
"price_id": "d88a8763-3e3d-4fc7-a7a5-2bc9117148bf",
|
|
3678
|
+
"product_id": "065d6618-cc59-45f4-8e3a-700edf6813c3",
|
|
3679
|
+
"quantity": 1
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"price_id": "e1ddf75a-d0d1-40b4-a07e-56e292867c88",
|
|
3683
|
+
"product_id": "5b9f05b7-f0f8-49c2-8a8d-0f8f923d6382",
|
|
3684
|
+
"quantity": 1
|
|
3685
|
+
}
|
|
3686
|
+
],
|
|
3687
|
+
"currency": "EUR",
|
|
3688
|
+
"payment_method": [
|
|
3689
|
+
{
|
|
3690
|
+
"type": "IBAN",
|
|
3691
|
+
"details": {}
|
|
3692
|
+
}
|
|
3693
|
+
],
|
|
3694
|
+
"billing_contact": {
|
|
3695
|
+
"$relation": [
|
|
3696
|
+
{
|
|
3697
|
+
"entity_id": "1834a54e-b68f-4f7f-a98a-fe16f11bc2a5",
|
|
3698
|
+
"_tags": []
|
|
3699
|
+
}
|
|
3700
|
+
]
|
|
3701
|
+
},
|
|
3702
|
+
"billing_first_name": "Joao",
|
|
3703
|
+
"billing_last_name": "Pinho",
|
|
3704
|
+
"billing_email": "j.pinho@epilot.cloud",
|
|
3705
|
+
"billing_company_name": "epilot cloud",
|
|
3706
|
+
"billing_address": [
|
|
3707
|
+
{
|
|
3708
|
+
"_tags": [],
|
|
3709
|
+
"street": "Im Media Park",
|
|
3710
|
+
"street_number": "8a",
|
|
3711
|
+
"postal_code": "52000",
|
|
3712
|
+
"city": "Cologne",
|
|
3713
|
+
"country": "DE",
|
|
3714
|
+
"additional_info": ""
|
|
3715
|
+
}
|
|
3716
|
+
],
|
|
3717
|
+
"delivery_address": [],
|
|
3718
|
+
"dates": [
|
|
3719
|
+
{
|
|
3720
|
+
"_tags": [
|
|
3721
|
+
"Instalation Date"
|
|
3722
|
+
],
|
|
3723
|
+
"dates": "",
|
|
3724
|
+
"value": "2022-06-30T16:29:00.000Z"
|
|
3725
|
+
}
|
|
3726
|
+
],
|
|
3727
|
+
"_id": "4c7c9562-f8f0-4af0-a3a6-6aebc5571a6e",
|
|
3728
|
+
"_org": "728",
|
|
3729
|
+
"_created_at": "2022-06-03T16:29:46.303Z",
|
|
3730
|
+
"_updated_at": "2022-06-03T16:29:46.303Z"
|
|
3731
|
+
}
|
|
3732
|
+
},
|
|
3287
3733
|
"order-with-composite-prices": {
|
|
3288
3734
|
"value": {
|
|
3289
3735
|
"metadata": [
|
|
@@ -3386,7 +3832,7 @@
|
|
|
3386
3832
|
"_schema": "tax",
|
|
3387
3833
|
"_title": "Tax Without Behaviour",
|
|
3388
3834
|
"description": "Without Behaviour",
|
|
3389
|
-
"rate":
|
|
3835
|
+
"rate": 6,
|
|
3390
3836
|
"_org": "739224",
|
|
3391
3837
|
"_created_at": "2022-02-07T14:49:08.831Z",
|
|
3392
3838
|
"_updated_at": "2022-02-07T14:49:08.831Z"
|
|
@@ -3617,7 +4063,7 @@
|
|
|
3617
4063
|
"_schema": "tax",
|
|
3618
4064
|
"_title": "Tax Without Behaviour",
|
|
3619
4065
|
"description": "Without Behaviour",
|
|
3620
|
-
"rate":
|
|
4066
|
+
"rate": 6,
|
|
3621
4067
|
"_org": "739224",
|
|
3622
4068
|
"_created_at": "2022-02-07T14:49:08.831Z",
|
|
3623
4069
|
"_updated_at": "2022-02-07T14:49:08.831Z"
|
|
@@ -3958,12 +4404,12 @@
|
|
|
3958
4404
|
"product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
|
|
3959
4405
|
"taxes": [
|
|
3960
4406
|
{
|
|
3961
|
-
"amount":
|
|
4407
|
+
"amount": 600,
|
|
3962
4408
|
"tax": {
|
|
3963
4409
|
"active": true,
|
|
3964
4410
|
"behavior": "Exclusive",
|
|
3965
4411
|
"description": "Without Behaviour",
|
|
3966
|
-
"rate":
|
|
4412
|
+
"rate": 6,
|
|
3967
4413
|
"region": "DE",
|
|
3968
4414
|
"type": "VAT",
|
|
3969
4415
|
"_created_at": "2022-02-07T14:49:08.831Z",
|