@chift/chift-nodejs 1.0.14 → 1.0.16
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/.eslintcache +1 -1
- package/CHANGELOG.md +10 -1
- package/dist/src/modules/api.d.ts +1174 -269
- package/dist/src/modules/consumer.d.ts +233 -53
- package/dist/src/modules/consumer.js +3 -0
- package/dist/src/modules/consumers.d.ts +1160 -260
- package/dist/src/modules/integrations.d.ts +6 -1
- package/dist/src/modules/pms.d.ts +15 -0
- package/dist/src/modules/pms.js +47 -0
- package/dist/src/modules/pos.d.ts +4 -4
- package/dist/src/modules/sync.d.ts +928 -208
- package/dist/src/types/public-api/schema.d.ts +1034 -298
- package/package.json +1 -1
- package/src/modules/consumer.ts +6 -1
- package/src/modules/pms.ts +67 -0
- package/src/modules/pos.ts +4 -4
- package/src/types/public-api/schema.d.ts +12073 -0
- package/src/types/public-api/schema.ts +1037 -294
- package/test/modules/pos.test.ts +1 -1
|
@@ -212,6 +212,10 @@ export interface paths {
|
|
|
212
212
|
/** Get Folders */
|
|
213
213
|
get: operations['accounting_get_folders'];
|
|
214
214
|
};
|
|
215
|
+
'/consumers/{consumer_id}/accounting/bookyears': {
|
|
216
|
+
/** Get Bookyears */
|
|
217
|
+
get: operations['accounting_get_bookyears'];
|
|
218
|
+
};
|
|
215
219
|
'/consumers/{consumer_id}/accounting/analytic-plans': {
|
|
216
220
|
/** Get Analytic Plans */
|
|
217
221
|
get: operations['accounting_get_analytic_plans'];
|
|
@@ -802,6 +806,48 @@ export interface paths {
|
|
|
802
806
|
*/
|
|
803
807
|
get: operations['payment_get_transaction'];
|
|
804
808
|
};
|
|
809
|
+
'/consumers/{consumer_id}/pms/orders': {
|
|
810
|
+
/**
|
|
811
|
+
* Get orders (PMS)
|
|
812
|
+
* @description Returns a list of the orders
|
|
813
|
+
*/
|
|
814
|
+
get: operations['pms_get_orders'];
|
|
815
|
+
};
|
|
816
|
+
'/consumers/{consumer_id}/pms/locations': {
|
|
817
|
+
/**
|
|
818
|
+
* Get locations (PMS)
|
|
819
|
+
* @description Returns a list of the locations
|
|
820
|
+
*/
|
|
821
|
+
get: operations['pms_get_locations'];
|
|
822
|
+
};
|
|
823
|
+
'/consumers/{consumer_id}/pms/payments': {
|
|
824
|
+
/**
|
|
825
|
+
* Get payments (PMS)
|
|
826
|
+
* @description Returns a list of payments
|
|
827
|
+
*/
|
|
828
|
+
get: operations['pms_get_payments'];
|
|
829
|
+
};
|
|
830
|
+
'/consumers/{consumer_id}/pms/payment-methods': {
|
|
831
|
+
/**
|
|
832
|
+
* Get payment methods (PMS)
|
|
833
|
+
* @description Returns the list of payment methods
|
|
834
|
+
*/
|
|
835
|
+
get: operations['pms_get_payments_methods'];
|
|
836
|
+
};
|
|
837
|
+
'/consumers/{consumer_id}/pms/accounting-categories': {
|
|
838
|
+
/**
|
|
839
|
+
* Get accounting categories (PMS)
|
|
840
|
+
* @description Returns a list of accounting categories. When not available for a specific PMS, it will return the same values as the product categories.
|
|
841
|
+
*/
|
|
842
|
+
get: operations['pms_get_accounting_categories'];
|
|
843
|
+
};
|
|
844
|
+
'/consumers/{consumer_id}/pms/closures/{date}': {
|
|
845
|
+
/**
|
|
846
|
+
* Get closure info for a specific day (PMS)
|
|
847
|
+
* @description Returns whether the closure was already done for a specific day or not
|
|
848
|
+
*/
|
|
849
|
+
get: operations['pms_get_closure'];
|
|
850
|
+
};
|
|
805
851
|
'/token': {
|
|
806
852
|
/**
|
|
807
853
|
* Get access token
|
|
@@ -817,9 +863,15 @@ export interface components {
|
|
|
817
863
|
schemas: {
|
|
818
864
|
/** AccountBalance */
|
|
819
865
|
AccountBalance: {
|
|
820
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* Account Number
|
|
868
|
+
* @description Number of the account
|
|
869
|
+
*/
|
|
821
870
|
account_number: string;
|
|
822
|
-
/**
|
|
871
|
+
/**
|
|
872
|
+
* Account Name
|
|
873
|
+
* @description Display name of the account
|
|
874
|
+
*/
|
|
823
875
|
account_name?: string;
|
|
824
876
|
/** Debit */
|
|
825
877
|
debit: number;
|
|
@@ -1126,7 +1178,8 @@ export interface components {
|
|
|
1126
1178
|
| 'Communication'
|
|
1127
1179
|
| 'Banking'
|
|
1128
1180
|
| 'Custom'
|
|
1129
|
-
| 'Payment'
|
|
1181
|
+
| 'Payment'
|
|
1182
|
+
| 'Property Management System';
|
|
1130
1183
|
/** AttachmentItem */
|
|
1131
1184
|
AttachmentItem: {
|
|
1132
1185
|
/** Base64 String */
|
|
@@ -1268,6 +1321,23 @@ export interface components {
|
|
|
1268
1321
|
*/
|
|
1269
1322
|
execution_date: string;
|
|
1270
1323
|
};
|
|
1324
|
+
/** BookYear */
|
|
1325
|
+
BookYear: {
|
|
1326
|
+
/** Name */
|
|
1327
|
+
name: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* Start
|
|
1330
|
+
* Format: date
|
|
1331
|
+
*/
|
|
1332
|
+
start: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* End
|
|
1335
|
+
* Format: date
|
|
1336
|
+
*/
|
|
1337
|
+
end: string;
|
|
1338
|
+
/** Closed */
|
|
1339
|
+
closed: boolean;
|
|
1340
|
+
};
|
|
1271
1341
|
/**
|
|
1272
1342
|
* BoolParam
|
|
1273
1343
|
* @description An enumeration.
|
|
@@ -1414,6 +1484,17 @@ export interface components {
|
|
|
1414
1484
|
/** Size */
|
|
1415
1485
|
size: number;
|
|
1416
1486
|
};
|
|
1487
|
+
/** ChiftPage[BookYear] */
|
|
1488
|
+
ChiftPage_BookYear_: {
|
|
1489
|
+
/** Items */
|
|
1490
|
+
items: components['schemas']['BookYear'][];
|
|
1491
|
+
/** Total */
|
|
1492
|
+
total: number;
|
|
1493
|
+
/** Page */
|
|
1494
|
+
page: number;
|
|
1495
|
+
/** Size */
|
|
1496
|
+
size: number;
|
|
1497
|
+
};
|
|
1417
1498
|
/** ChiftPage[CategoryItem] */
|
|
1418
1499
|
ChiftPage_CategoryItem_: {
|
|
1419
1500
|
/** Items */
|
|
@@ -1590,10 +1671,10 @@ export interface components {
|
|
|
1590
1671
|
/** Size */
|
|
1591
1672
|
size: number;
|
|
1592
1673
|
};
|
|
1593
|
-
/** ChiftPage[
|
|
1594
|
-
|
|
1674
|
+
/** ChiftPage[OutstandingItem] */
|
|
1675
|
+
ChiftPage_OutstandingItem_: {
|
|
1595
1676
|
/** Items */
|
|
1596
|
-
items: components['schemas']['
|
|
1677
|
+
items: components['schemas']['OutstandingItem'][];
|
|
1597
1678
|
/** Total */
|
|
1598
1679
|
total: number;
|
|
1599
1680
|
/** Page */
|
|
@@ -1601,10 +1682,54 @@ export interface components {
|
|
|
1601
1682
|
/** Size */
|
|
1602
1683
|
size: number;
|
|
1603
1684
|
};
|
|
1604
|
-
/** ChiftPage[
|
|
1605
|
-
|
|
1685
|
+
/** ChiftPage[PMSAccountingCategoryItem] */
|
|
1686
|
+
ChiftPage_PMSAccountingCategoryItem_: {
|
|
1606
1687
|
/** Items */
|
|
1607
|
-
items: components['schemas']['
|
|
1688
|
+
items: components['schemas']['PMSAccountingCategoryItem'][];
|
|
1689
|
+
/** Total */
|
|
1690
|
+
total: number;
|
|
1691
|
+
/** Page */
|
|
1692
|
+
page: number;
|
|
1693
|
+
/** Size */
|
|
1694
|
+
size: number;
|
|
1695
|
+
};
|
|
1696
|
+
/** ChiftPage[PMSLocationItem] */
|
|
1697
|
+
ChiftPage_PMSLocationItem_: {
|
|
1698
|
+
/** Items */
|
|
1699
|
+
items: components['schemas']['PMSLocationItem'][];
|
|
1700
|
+
/** Total */
|
|
1701
|
+
total: number;
|
|
1702
|
+
/** Page */
|
|
1703
|
+
page: number;
|
|
1704
|
+
/** Size */
|
|
1705
|
+
size: number;
|
|
1706
|
+
};
|
|
1707
|
+
/** ChiftPage[PMSOrderItem] */
|
|
1708
|
+
ChiftPage_PMSOrderItem_: {
|
|
1709
|
+
/** Items */
|
|
1710
|
+
items: components['schemas']['PMSOrderItem'][];
|
|
1711
|
+
/** Total */
|
|
1712
|
+
total: number;
|
|
1713
|
+
/** Page */
|
|
1714
|
+
page: number;
|
|
1715
|
+
/** Size */
|
|
1716
|
+
size: number;
|
|
1717
|
+
};
|
|
1718
|
+
/** ChiftPage[PMSPaymentItem] */
|
|
1719
|
+
ChiftPage_PMSPaymentItem_: {
|
|
1720
|
+
/** Items */
|
|
1721
|
+
items: components['schemas']['PMSPaymentItem'][];
|
|
1722
|
+
/** Total */
|
|
1723
|
+
total: number;
|
|
1724
|
+
/** Page */
|
|
1725
|
+
page: number;
|
|
1726
|
+
/** Size */
|
|
1727
|
+
size: number;
|
|
1728
|
+
};
|
|
1729
|
+
/** ChiftPage[PMSPaymentMethods] */
|
|
1730
|
+
ChiftPage_PMSPaymentMethods_: {
|
|
1731
|
+
/** Items */
|
|
1732
|
+
items: components['schemas']['PMSPaymentMethods'][];
|
|
1608
1733
|
/** Total */
|
|
1609
1734
|
total: number;
|
|
1610
1735
|
/** Page */
|
|
@@ -1634,10 +1759,21 @@ export interface components {
|
|
|
1634
1759
|
/** Size */
|
|
1635
1760
|
size: number;
|
|
1636
1761
|
};
|
|
1637
|
-
/** ChiftPage[
|
|
1638
|
-
|
|
1762
|
+
/** ChiftPage[POSOrderItem] */
|
|
1763
|
+
ChiftPage_POSOrderItem_: {
|
|
1639
1764
|
/** Items */
|
|
1640
|
-
items: components['schemas']['
|
|
1765
|
+
items: components['schemas']['POSOrderItem'][];
|
|
1766
|
+
/** Total */
|
|
1767
|
+
total: number;
|
|
1768
|
+
/** Page */
|
|
1769
|
+
page: number;
|
|
1770
|
+
/** Size */
|
|
1771
|
+
size: number;
|
|
1772
|
+
};
|
|
1773
|
+
/** ChiftPage[POSPaymentItem] */
|
|
1774
|
+
ChiftPage_POSPaymentItem_: {
|
|
1775
|
+
/** Items */
|
|
1776
|
+
items: components['schemas']['POSPaymentItem'][];
|
|
1641
1777
|
/** Total */
|
|
1642
1778
|
total: number;
|
|
1643
1779
|
/** Page */
|
|
@@ -1645,10 +1781,10 @@ export interface components {
|
|
|
1645
1781
|
/** Size */
|
|
1646
1782
|
size: number;
|
|
1647
1783
|
};
|
|
1648
|
-
/** ChiftPage[
|
|
1649
|
-
|
|
1784
|
+
/** ChiftPage[POSProductItem] */
|
|
1785
|
+
ChiftPage_POSProductItem_: {
|
|
1650
1786
|
/** Items */
|
|
1651
|
-
items: components['schemas']['
|
|
1787
|
+
items: components['schemas']['POSProductItem'][];
|
|
1652
1788
|
/** Total */
|
|
1653
1789
|
total: number;
|
|
1654
1790
|
/** Page */
|
|
@@ -2903,6 +3039,10 @@ export interface components {
|
|
|
2903
3039
|
* @default true
|
|
2904
3040
|
*/
|
|
2905
3041
|
selected?: boolean;
|
|
3042
|
+
/** Vat */
|
|
3043
|
+
vat?: string;
|
|
3044
|
+
/** Company Number */
|
|
3045
|
+
company_number?: string;
|
|
2906
3046
|
};
|
|
2907
3047
|
/** GenericJournalEntry */
|
|
2908
3048
|
GenericJournalEntry: {
|
|
@@ -3020,6 +3160,12 @@ export interface components {
|
|
|
3020
3160
|
logo_url: string;
|
|
3021
3161
|
/** Icon Url */
|
|
3022
3162
|
icon_url: string;
|
|
3163
|
+
/**
|
|
3164
|
+
* Post Connections
|
|
3165
|
+
* @description List of post-connections that can be activated for this integration.
|
|
3166
|
+
* @default []
|
|
3167
|
+
*/
|
|
3168
|
+
post_connections?: components['schemas']['app__routers__integrations__PostConnectionItem'][];
|
|
3023
3169
|
/**
|
|
3024
3170
|
* Credentials
|
|
3025
3171
|
* @description List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.
|
|
@@ -3195,6 +3341,8 @@ export interface components {
|
|
|
3195
3341
|
*/
|
|
3196
3342
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3197
3343
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3344
|
+
/** Shipping Country */
|
|
3345
|
+
shipping_country?: string;
|
|
3198
3346
|
/** Lines */
|
|
3199
3347
|
lines: components['schemas']['InvoiceLineItemInMonoAnalyticPlan'][];
|
|
3200
3348
|
};
|
|
@@ -3259,6 +3407,8 @@ export interface components {
|
|
|
3259
3407
|
*/
|
|
3260
3408
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3261
3409
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3410
|
+
/** Shipping Country */
|
|
3411
|
+
shipping_country?: string;
|
|
3262
3412
|
/** Lines */
|
|
3263
3413
|
lines: components['schemas']['InvoiceLineItemInMultiAnalyticPlans'][];
|
|
3264
3414
|
};
|
|
@@ -3843,38 +3993,6 @@ export interface components {
|
|
|
3843
3993
|
| 'supplier_invoice'
|
|
3844
3994
|
| 'supplier_refund'
|
|
3845
3995
|
| 'all';
|
|
3846
|
-
/** Item */
|
|
3847
|
-
Item: {
|
|
3848
|
-
/** Id */
|
|
3849
|
-
id: string;
|
|
3850
|
-
/** Quantity */
|
|
3851
|
-
quantity: number;
|
|
3852
|
-
/** Unit Price */
|
|
3853
|
-
unit_price: number;
|
|
3854
|
-
/** Total */
|
|
3855
|
-
total: number;
|
|
3856
|
-
/** Tax Amount */
|
|
3857
|
-
tax_amount: number;
|
|
3858
|
-
/** Tax Rate */
|
|
3859
|
-
tax_rate?: number;
|
|
3860
|
-
/** Description */
|
|
3861
|
-
description?: string;
|
|
3862
|
-
/**
|
|
3863
|
-
* Discounts
|
|
3864
|
-
* @default []
|
|
3865
|
-
*/
|
|
3866
|
-
discounts?: components['schemas']['app__routers__pos__DiscountItem'][];
|
|
3867
|
-
/**
|
|
3868
|
-
* Product Id
|
|
3869
|
-
* @description Reference to the product related to this item
|
|
3870
|
-
*/
|
|
3871
|
-
product_id?: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* Accounting Category Id
|
|
3874
|
-
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
3875
|
-
*/
|
|
3876
|
-
accounting_category_id?: string;
|
|
3877
|
-
};
|
|
3878
3996
|
/** Journal */
|
|
3879
3997
|
Journal: {
|
|
3880
3998
|
/** Id */
|
|
@@ -4367,63 +4485,6 @@ export interface components {
|
|
|
4367
4485
|
*/
|
|
4368
4486
|
id: string;
|
|
4369
4487
|
};
|
|
4370
|
-
/** OrderItem */
|
|
4371
|
-
OrderItem: {
|
|
4372
|
-
/** Id */
|
|
4373
|
-
id: string;
|
|
4374
|
-
/** Order Number */
|
|
4375
|
-
order_number?: string;
|
|
4376
|
-
/**
|
|
4377
|
-
* Creation Date
|
|
4378
|
-
* Format: date-time
|
|
4379
|
-
*/
|
|
4380
|
-
creation_date: string;
|
|
4381
|
-
/**
|
|
4382
|
-
* Closing Date
|
|
4383
|
-
* Format: date-time
|
|
4384
|
-
*/
|
|
4385
|
-
closing_date?: string;
|
|
4386
|
-
/**
|
|
4387
|
-
* Service Date
|
|
4388
|
-
* Format: date-time
|
|
4389
|
-
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
4390
|
-
*/
|
|
4391
|
-
service_date?: string;
|
|
4392
|
-
/**
|
|
4393
|
-
* Device Id
|
|
4394
|
-
* @description ID of device that created the order
|
|
4395
|
-
*/
|
|
4396
|
-
device_id?: string;
|
|
4397
|
-
/** Total */
|
|
4398
|
-
total: number;
|
|
4399
|
-
/** Tax Amount */
|
|
4400
|
-
tax_amount: number;
|
|
4401
|
-
/** Total Discount */
|
|
4402
|
-
total_discount?: number;
|
|
4403
|
-
/** Total Refund */
|
|
4404
|
-
total_refund?: number;
|
|
4405
|
-
/**
|
|
4406
|
-
* Total Tip
|
|
4407
|
-
* @default 0
|
|
4408
|
-
*/
|
|
4409
|
-
total_tip?: number;
|
|
4410
|
-
/** Items */
|
|
4411
|
-
items: components['schemas']['Item'][];
|
|
4412
|
-
/** Payments */
|
|
4413
|
-
payments: components['schemas']['PaymentItem'][];
|
|
4414
|
-
/** Currency */
|
|
4415
|
-
currency?: string;
|
|
4416
|
-
/** Country */
|
|
4417
|
-
country?: string;
|
|
4418
|
-
/** Loyalty */
|
|
4419
|
-
loyalty?: number;
|
|
4420
|
-
/** Customer Id */
|
|
4421
|
-
customer_id?: string;
|
|
4422
|
-
/** Location Id */
|
|
4423
|
-
location_id?: string;
|
|
4424
|
-
/** Taxes */
|
|
4425
|
-
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4426
|
-
};
|
|
4427
4488
|
/** OrderItemIn */
|
|
4428
4489
|
OrderItemIn: {
|
|
4429
4490
|
customer: components['schemas']['OrderCustomerItem'];
|
|
@@ -4476,6 +4537,11 @@ export interface components {
|
|
|
4476
4537
|
* Format: date-time
|
|
4477
4538
|
*/
|
|
4478
4539
|
confirmed_on?: string;
|
|
4540
|
+
/**
|
|
4541
|
+
* Delivery Date
|
|
4542
|
+
* Format: date-time
|
|
4543
|
+
*/
|
|
4544
|
+
delivery_date?: string;
|
|
4479
4545
|
/**
|
|
4480
4546
|
* Cancelled On
|
|
4481
4547
|
* Format: date-time
|
|
@@ -4649,6 +4715,11 @@ export interface components {
|
|
|
4649
4715
|
sku?: string;
|
|
4650
4716
|
/** Name */
|
|
4651
4717
|
name: string;
|
|
4718
|
+
/**
|
|
4719
|
+
* Categories
|
|
4720
|
+
* @default []
|
|
4721
|
+
*/
|
|
4722
|
+
categories?: components['schemas']['app__routers__commerce__ProductCategoryItem'][];
|
|
4652
4723
|
};
|
|
4653
4724
|
/** OrderPaymentMethods */
|
|
4654
4725
|
OrderPaymentMethods: {
|
|
@@ -4699,13 +4770,24 @@ export interface components {
|
|
|
4699
4770
|
* @default []
|
|
4700
4771
|
*/
|
|
4701
4772
|
shipping_refunds?: components['schemas']['ShippingRefund'][];
|
|
4773
|
+
/**
|
|
4774
|
+
* Transactions
|
|
4775
|
+
* @default []
|
|
4776
|
+
*/
|
|
4777
|
+
transactions?: components['schemas']['OrderTransactions'][];
|
|
4702
4778
|
};
|
|
4703
4779
|
/**
|
|
4704
4780
|
* OrderStatus
|
|
4705
4781
|
* @description An enumeration.
|
|
4706
4782
|
* @enum {string}
|
|
4707
4783
|
*/
|
|
4708
|
-
OrderStatus:
|
|
4784
|
+
OrderStatus:
|
|
4785
|
+
| 'cancelled_unpaid'
|
|
4786
|
+
| 'cancelled'
|
|
4787
|
+
| 'draft'
|
|
4788
|
+
| 'confirmed'
|
|
4789
|
+
| 'shipped'
|
|
4790
|
+
| 'refunded';
|
|
4709
4791
|
/** OrderTransactions */
|
|
4710
4792
|
OrderTransactions: {
|
|
4711
4793
|
/**
|
|
@@ -4713,6 +4795,11 @@ export interface components {
|
|
|
4713
4795
|
* @description Technical id of the transaction in the eCommerce
|
|
4714
4796
|
*/
|
|
4715
4797
|
id: string;
|
|
4798
|
+
/**
|
|
4799
|
+
* Created On
|
|
4800
|
+
* Format: date-time
|
|
4801
|
+
*/
|
|
4802
|
+
created_on?: string;
|
|
4716
4803
|
/**
|
|
4717
4804
|
* Payment Method Id
|
|
4718
4805
|
* @description Technical id of the payment method in the eCommerce
|
|
@@ -4771,51 +4858,302 @@ export interface components {
|
|
|
4771
4858
|
* @enum {string}
|
|
4772
4859
|
*/
|
|
4773
4860
|
OutstandingType: 'client' | 'supplier';
|
|
4774
|
-
/**
|
|
4775
|
-
|
|
4776
|
-
/** First Name */
|
|
4777
|
-
first_name: string;
|
|
4778
|
-
/** Last Name */
|
|
4779
|
-
last_name: string;
|
|
4780
|
-
/** Phone */
|
|
4781
|
-
phone?: string;
|
|
4782
|
-
/** Email */
|
|
4783
|
-
email?: string;
|
|
4784
|
-
address?: components['schemas']['PostAddressItem'];
|
|
4785
|
-
};
|
|
4786
|
-
/** POSCustomerItem */
|
|
4787
|
-
POSCustomerItem: {
|
|
4861
|
+
/** PMSAccountingCategoryItem */
|
|
4862
|
+
PMSAccountingCategoryItem: {
|
|
4788
4863
|
/** Id */
|
|
4789
4864
|
id: string;
|
|
4790
|
-
/**
|
|
4791
|
-
|
|
4792
|
-
|
|
4793
|
-
|
|
4865
|
+
/**
|
|
4866
|
+
* Source Ref
|
|
4867
|
+
* @description Technical id in the target software
|
|
4868
|
+
*/
|
|
4869
|
+
source_ref: components['schemas']['Ref'];
|
|
4794
4870
|
/** Name */
|
|
4795
4871
|
name: string;
|
|
4796
|
-
/** Phone */
|
|
4797
|
-
phone?: string;
|
|
4798
|
-
/** Email */
|
|
4799
|
-
email?: string;
|
|
4800
4872
|
/**
|
|
4801
|
-
*
|
|
4802
|
-
*
|
|
4873
|
+
* Id Parent
|
|
4874
|
+
* @description Indicates if the category belongs to a parent category
|
|
4803
4875
|
*/
|
|
4804
|
-
|
|
4805
|
-
/** Addresses */
|
|
4806
|
-
addresses?: components['schemas']['AddressItem'][];
|
|
4807
|
-
/** Loyalty */
|
|
4808
|
-
loyalty?: number;
|
|
4876
|
+
id_parent?: string;
|
|
4809
4877
|
/**
|
|
4810
|
-
*
|
|
4811
|
-
*
|
|
4812
|
-
* @description Birthdate
|
|
4878
|
+
* Code
|
|
4879
|
+
* @description Code assigned to the category
|
|
4813
4880
|
*/
|
|
4814
|
-
|
|
4815
|
-
|
|
4816
|
-
|
|
4817
|
-
|
|
4818
|
-
|
|
4881
|
+
code?: string;
|
|
4882
|
+
/**
|
|
4883
|
+
* Ledger Account Code
|
|
4884
|
+
* @description Ledger account code assigned to the category
|
|
4885
|
+
*/
|
|
4886
|
+
ledger_account_code?: string;
|
|
4887
|
+
/**
|
|
4888
|
+
* Posting Account Code
|
|
4889
|
+
* @description Posting account code assigned to the category
|
|
4890
|
+
*/
|
|
4891
|
+
posting_account_code?: string;
|
|
4892
|
+
};
|
|
4893
|
+
/** PMSClosureItem */
|
|
4894
|
+
PMSClosureItem: {
|
|
4895
|
+
/**
|
|
4896
|
+
* Date
|
|
4897
|
+
* Format: date
|
|
4898
|
+
*/
|
|
4899
|
+
date: string;
|
|
4900
|
+
status: components['schemas']['ClosureStates'];
|
|
4901
|
+
};
|
|
4902
|
+
/** PMSLocationItem */
|
|
4903
|
+
PMSLocationItem: {
|
|
4904
|
+
/** Id */
|
|
4905
|
+
id: string;
|
|
4906
|
+
/** Name */
|
|
4907
|
+
name: string;
|
|
4908
|
+
/**
|
|
4909
|
+
* Timezone
|
|
4910
|
+
* @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
|
|
4911
|
+
*/
|
|
4912
|
+
timezone?: string;
|
|
4913
|
+
address?: components['schemas']['AddressItem'];
|
|
4914
|
+
};
|
|
4915
|
+
/** PMSOrderItem */
|
|
4916
|
+
PMSOrderItem: {
|
|
4917
|
+
/** Id */
|
|
4918
|
+
id: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* Source Ref
|
|
4921
|
+
* @description Technical id in the target software
|
|
4922
|
+
*/
|
|
4923
|
+
source_ref: components['schemas']['Ref'];
|
|
4924
|
+
/** Order Number */
|
|
4925
|
+
order_number?: string;
|
|
4926
|
+
/**
|
|
4927
|
+
* Creation Date
|
|
4928
|
+
* Format: date-time
|
|
4929
|
+
*/
|
|
4930
|
+
creation_date: string;
|
|
4931
|
+
/**
|
|
4932
|
+
* Closing Date
|
|
4933
|
+
* Format: date-time
|
|
4934
|
+
*/
|
|
4935
|
+
closing_date?: string;
|
|
4936
|
+
/**
|
|
4937
|
+
* Service Date
|
|
4938
|
+
* Format: date-time
|
|
4939
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
4940
|
+
*/
|
|
4941
|
+
service_date?: string;
|
|
4942
|
+
/**
|
|
4943
|
+
* Device Id
|
|
4944
|
+
* @description ID of device that created the order
|
|
4945
|
+
*/
|
|
4946
|
+
device_id?: string;
|
|
4947
|
+
/** Total */
|
|
4948
|
+
total: number;
|
|
4949
|
+
/** Tax Amount */
|
|
4950
|
+
tax_amount: number;
|
|
4951
|
+
/**
|
|
4952
|
+
* Total Discount
|
|
4953
|
+
* @default 0
|
|
4954
|
+
*/
|
|
4955
|
+
total_discount?: number;
|
|
4956
|
+
/**
|
|
4957
|
+
* Total Refund
|
|
4958
|
+
* @default 0
|
|
4959
|
+
*/
|
|
4960
|
+
total_refund?: number;
|
|
4961
|
+
/**
|
|
4962
|
+
* Total Tip
|
|
4963
|
+
* @default 0
|
|
4964
|
+
*/
|
|
4965
|
+
total_tip?: number;
|
|
4966
|
+
/** Currency */
|
|
4967
|
+
currency?: string;
|
|
4968
|
+
/** Country */
|
|
4969
|
+
country?: string;
|
|
4970
|
+
/** Loyalty */
|
|
4971
|
+
loyalty?: number;
|
|
4972
|
+
/** Customer Id */
|
|
4973
|
+
customer_id?: string;
|
|
4974
|
+
/** Location Id */
|
|
4975
|
+
location_id?: string;
|
|
4976
|
+
/** Taxes */
|
|
4977
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4978
|
+
/** Guests */
|
|
4979
|
+
guests?: number;
|
|
4980
|
+
/** Items */
|
|
4981
|
+
items: components['schemas']['PMSOrderLineItem'][];
|
|
4982
|
+
/**
|
|
4983
|
+
* Service Id
|
|
4984
|
+
* @description Reference to the service related to this order
|
|
4985
|
+
*/
|
|
4986
|
+
service_id?: string;
|
|
4987
|
+
};
|
|
4988
|
+
/** PMSOrderLineItem */
|
|
4989
|
+
PMSOrderLineItem: {
|
|
4990
|
+
/** Id */
|
|
4991
|
+
id: string;
|
|
4992
|
+
/**
|
|
4993
|
+
* Source Ref
|
|
4994
|
+
* @description Technical id in the target software
|
|
4995
|
+
*/
|
|
4996
|
+
source_ref: components['schemas']['Ref'];
|
|
4997
|
+
/** Quantity */
|
|
4998
|
+
quantity: number;
|
|
4999
|
+
/** Unit Price */
|
|
5000
|
+
unit_price: number;
|
|
5001
|
+
/** Total */
|
|
5002
|
+
total: number;
|
|
5003
|
+
/** Tax Amount */
|
|
5004
|
+
tax_amount: number;
|
|
5005
|
+
/** Tax Rate */
|
|
5006
|
+
tax_rate?: number;
|
|
5007
|
+
/** Description */
|
|
5008
|
+
description?: string;
|
|
5009
|
+
/**
|
|
5010
|
+
* Discounts
|
|
5011
|
+
* @default []
|
|
5012
|
+
*/
|
|
5013
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
5014
|
+
/**
|
|
5015
|
+
* Product Id
|
|
5016
|
+
* @description Reference to the product related to this item
|
|
5017
|
+
*/
|
|
5018
|
+
product_id?: string;
|
|
5019
|
+
/**
|
|
5020
|
+
* Accounting Category Id
|
|
5021
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
5022
|
+
*/
|
|
5023
|
+
accounting_category_id?: string;
|
|
5024
|
+
};
|
|
5025
|
+
/** PMSPaymentItem */
|
|
5026
|
+
PMSPaymentItem: {
|
|
5027
|
+
/** Id */
|
|
5028
|
+
id?: string;
|
|
5029
|
+
/**
|
|
5030
|
+
* Source Ref
|
|
5031
|
+
* @description Technical id in the target software
|
|
5032
|
+
*/
|
|
5033
|
+
source_ref: components['schemas']['Ref'];
|
|
5034
|
+
/** Payment Method Id */
|
|
5035
|
+
payment_method_id?: string;
|
|
5036
|
+
/** Payment Method Name */
|
|
5037
|
+
payment_method_name?: string;
|
|
5038
|
+
/** Total */
|
|
5039
|
+
total: number;
|
|
5040
|
+
/**
|
|
5041
|
+
* Tip
|
|
5042
|
+
* @default 0
|
|
5043
|
+
*/
|
|
5044
|
+
tip?: number;
|
|
5045
|
+
/** @default Unknown */
|
|
5046
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5047
|
+
/** Currency */
|
|
5048
|
+
currency?: string;
|
|
5049
|
+
/**
|
|
5050
|
+
* Date
|
|
5051
|
+
* Format: date-time
|
|
5052
|
+
*/
|
|
5053
|
+
date?: string;
|
|
5054
|
+
};
|
|
5055
|
+
/** PMSPaymentMethods */
|
|
5056
|
+
PMSPaymentMethods: {
|
|
5057
|
+
/** Id */
|
|
5058
|
+
id: string;
|
|
5059
|
+
/**
|
|
5060
|
+
* Source Ref
|
|
5061
|
+
* @description Technical id in the target software
|
|
5062
|
+
*/
|
|
5063
|
+
source_ref: components['schemas']['Ref'];
|
|
5064
|
+
/** Name */
|
|
5065
|
+
name: string;
|
|
5066
|
+
/** Extra */
|
|
5067
|
+
extra?: string;
|
|
5068
|
+
/**
|
|
5069
|
+
* Ledger Account Code
|
|
5070
|
+
* @description Ledger account code assigned to the category
|
|
5071
|
+
*/
|
|
5072
|
+
ledger_account_code?: string;
|
|
5073
|
+
};
|
|
5074
|
+
/**
|
|
5075
|
+
* PMSStates
|
|
5076
|
+
* @description An enumeration.
|
|
5077
|
+
* @enum {unknown}
|
|
5078
|
+
*/
|
|
5079
|
+
PMSStates: 'consumed' | 'closed';
|
|
5080
|
+
/** POSCreateCustomerItem */
|
|
5081
|
+
POSCreateCustomerItem: {
|
|
5082
|
+
/** First Name */
|
|
5083
|
+
first_name: string;
|
|
5084
|
+
/** Last Name */
|
|
5085
|
+
last_name: string;
|
|
5086
|
+
/** Phone */
|
|
5087
|
+
phone?: string;
|
|
5088
|
+
/** Email */
|
|
5089
|
+
email?: string;
|
|
5090
|
+
address?: components['schemas']['PostAddressItem'];
|
|
5091
|
+
};
|
|
5092
|
+
/** POSCustomerItem */
|
|
5093
|
+
POSCustomerItem: {
|
|
5094
|
+
/** Id */
|
|
5095
|
+
id: string;
|
|
5096
|
+
/** First Name */
|
|
5097
|
+
first_name?: string;
|
|
5098
|
+
/** Last Name */
|
|
5099
|
+
last_name?: string;
|
|
5100
|
+
/** Name */
|
|
5101
|
+
name: string;
|
|
5102
|
+
/** Phone */
|
|
5103
|
+
phone?: string;
|
|
5104
|
+
/** Email */
|
|
5105
|
+
email?: string;
|
|
5106
|
+
/**
|
|
5107
|
+
* Created On
|
|
5108
|
+
* Format: date-time
|
|
5109
|
+
*/
|
|
5110
|
+
created_on?: string;
|
|
5111
|
+
/** Addresses */
|
|
5112
|
+
addresses?: components['schemas']['AddressItem'][];
|
|
5113
|
+
/** Loyalty */
|
|
5114
|
+
loyalty?: number;
|
|
5115
|
+
/**
|
|
5116
|
+
* Birthdate
|
|
5117
|
+
* Format: date
|
|
5118
|
+
* @description Birthdate
|
|
5119
|
+
*/
|
|
5120
|
+
birthdate?: string;
|
|
5121
|
+
};
|
|
5122
|
+
/** POSItem */
|
|
5123
|
+
POSItem: {
|
|
5124
|
+
/** Id */
|
|
5125
|
+
id: string;
|
|
5126
|
+
/** Quantity */
|
|
5127
|
+
quantity: number;
|
|
5128
|
+
/** Unit Price */
|
|
5129
|
+
unit_price: number;
|
|
5130
|
+
/** Total */
|
|
5131
|
+
total: number;
|
|
5132
|
+
/** Tax Amount */
|
|
5133
|
+
tax_amount: number;
|
|
5134
|
+
/** Tax Rate */
|
|
5135
|
+
tax_rate?: number;
|
|
5136
|
+
/** Description */
|
|
5137
|
+
description?: string;
|
|
5138
|
+
/**
|
|
5139
|
+
* Discounts
|
|
5140
|
+
* @default []
|
|
5141
|
+
*/
|
|
5142
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
5143
|
+
/**
|
|
5144
|
+
* Product Id
|
|
5145
|
+
* @description Reference to the product related to this item
|
|
5146
|
+
*/
|
|
5147
|
+
product_id?: string;
|
|
5148
|
+
/**
|
|
5149
|
+
* Accounting Category Id
|
|
5150
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
5151
|
+
*/
|
|
5152
|
+
accounting_category_id?: string;
|
|
5153
|
+
};
|
|
5154
|
+
/** POSLocationItem */
|
|
5155
|
+
POSLocationItem: {
|
|
5156
|
+
/** Id */
|
|
4819
5157
|
id: string;
|
|
4820
5158
|
/** Name */
|
|
4821
5159
|
name: string;
|
|
@@ -4826,6 +5164,96 @@ export interface components {
|
|
|
4826
5164
|
timezone?: string;
|
|
4827
5165
|
address?: components['schemas']['AddressItem'];
|
|
4828
5166
|
};
|
|
5167
|
+
/** POSOrderItem */
|
|
5168
|
+
POSOrderItem: {
|
|
5169
|
+
/** Id */
|
|
5170
|
+
id: string;
|
|
5171
|
+
/** Order Number */
|
|
5172
|
+
order_number?: string;
|
|
5173
|
+
/**
|
|
5174
|
+
* Creation Date
|
|
5175
|
+
* Format: date-time
|
|
5176
|
+
*/
|
|
5177
|
+
creation_date: string;
|
|
5178
|
+
/**
|
|
5179
|
+
* Closing Date
|
|
5180
|
+
* Format: date-time
|
|
5181
|
+
*/
|
|
5182
|
+
closing_date?: string;
|
|
5183
|
+
/**
|
|
5184
|
+
* Service Date
|
|
5185
|
+
* Format: date-time
|
|
5186
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
5187
|
+
*/
|
|
5188
|
+
service_date?: string;
|
|
5189
|
+
/**
|
|
5190
|
+
* Device Id
|
|
5191
|
+
* @description ID of device that created the order
|
|
5192
|
+
*/
|
|
5193
|
+
device_id?: string;
|
|
5194
|
+
/** Total */
|
|
5195
|
+
total: number;
|
|
5196
|
+
/** Tax Amount */
|
|
5197
|
+
tax_amount: number;
|
|
5198
|
+
/**
|
|
5199
|
+
* Total Discount
|
|
5200
|
+
* @default 0
|
|
5201
|
+
*/
|
|
5202
|
+
total_discount?: number;
|
|
5203
|
+
/**
|
|
5204
|
+
* Total Refund
|
|
5205
|
+
* @default 0
|
|
5206
|
+
*/
|
|
5207
|
+
total_refund?: number;
|
|
5208
|
+
/**
|
|
5209
|
+
* Total Tip
|
|
5210
|
+
* @default 0
|
|
5211
|
+
*/
|
|
5212
|
+
total_tip?: number;
|
|
5213
|
+
/** Currency */
|
|
5214
|
+
currency?: string;
|
|
5215
|
+
/** Country */
|
|
5216
|
+
country?: string;
|
|
5217
|
+
/** Loyalty */
|
|
5218
|
+
loyalty?: number;
|
|
5219
|
+
/** Customer Id */
|
|
5220
|
+
customer_id?: string;
|
|
5221
|
+
/** Location Id */
|
|
5222
|
+
location_id?: string;
|
|
5223
|
+
/** Taxes */
|
|
5224
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
5225
|
+
/** Guests */
|
|
5226
|
+
guests?: number;
|
|
5227
|
+
/** Payments */
|
|
5228
|
+
payments: components['schemas']['POSPaymentItem'][];
|
|
5229
|
+
/** Items */
|
|
5230
|
+
items: components['schemas']['POSItem'][];
|
|
5231
|
+
};
|
|
5232
|
+
/** POSPaymentItem */
|
|
5233
|
+
POSPaymentItem: {
|
|
5234
|
+
/** Id */
|
|
5235
|
+
id?: string;
|
|
5236
|
+
/** Payment Method Id */
|
|
5237
|
+
payment_method_id?: string;
|
|
5238
|
+
/** Payment Method Name */
|
|
5239
|
+
payment_method_name?: string;
|
|
5240
|
+
/** Total */
|
|
5241
|
+
total: number;
|
|
5242
|
+
/**
|
|
5243
|
+
* Tip
|
|
5244
|
+
* @default 0
|
|
5245
|
+
*/
|
|
5246
|
+
tip?: number;
|
|
5247
|
+
/** @default Unknown */
|
|
5248
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5249
|
+
/** Currency */
|
|
5250
|
+
currency?: string;
|
|
5251
|
+
/**
|
|
5252
|
+
* Date
|
|
5253
|
+
* Format: date-time
|
|
5254
|
+
*/
|
|
5255
|
+
date?: string;
|
|
5256
|
+
};
|
|
4829
5257
|
/** POSProductItem */
|
|
4830
5258
|
POSProductItem: {
|
|
4831
5259
|
/** Id */
|
|
@@ -4949,31 +5377,6 @@ export interface components {
|
|
|
4949
5377
|
/** Matching Number */
|
|
4950
5378
|
matching_number?: string;
|
|
4951
5379
|
};
|
|
4952
|
-
/** PaymentItem */
|
|
4953
|
-
PaymentItem: {
|
|
4954
|
-
/** Id */
|
|
4955
|
-
id?: string;
|
|
4956
|
-
/** Payment Method Id */
|
|
4957
|
-
payment_method_id?: string;
|
|
4958
|
-
/** Payment Method Name */
|
|
4959
|
-
payment_method_name?: string;
|
|
4960
|
-
/** Total */
|
|
4961
|
-
total: number;
|
|
4962
|
-
/**
|
|
4963
|
-
* Tip
|
|
4964
|
-
* @default 0
|
|
4965
|
-
*/
|
|
4966
|
-
tip?: number;
|
|
4967
|
-
/** @default Unknown */
|
|
4968
|
-
status?: components['schemas']['app__routers__pos__PaymentStatus'];
|
|
4969
|
-
/** Currency */
|
|
4970
|
-
currency?: string;
|
|
4971
|
-
/**
|
|
4972
|
-
* Date
|
|
4973
|
-
* Format: date-time
|
|
4974
|
-
*/
|
|
4975
|
-
date?: string;
|
|
4976
|
-
};
|
|
4977
5380
|
/** PaymentMethodItem */
|
|
4978
5381
|
PaymentMethodItem: {
|
|
4979
5382
|
/**
|
|
@@ -5024,24 +5427,6 @@ export interface components {
|
|
|
5024
5427
|
/** Country */
|
|
5025
5428
|
country?: string;
|
|
5026
5429
|
};
|
|
5027
|
-
/** PostConnectionItem */
|
|
5028
|
-
PostConnectionItem: {
|
|
5029
|
-
/**
|
|
5030
|
-
* Integrationid
|
|
5031
|
-
* @description Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
5032
|
-
*/
|
|
5033
|
-
integrationid?: number;
|
|
5034
|
-
/**
|
|
5035
|
-
* Name
|
|
5036
|
-
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
5037
|
-
*/
|
|
5038
|
-
name?: string;
|
|
5039
|
-
/**
|
|
5040
|
-
* Credentials
|
|
5041
|
-
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
5042
|
-
*/
|
|
5043
|
-
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
5044
|
-
};
|
|
5045
5430
|
/** PostConsumerItem */
|
|
5046
5431
|
PostConsumerItem: {
|
|
5047
5432
|
/** Name */
|
|
@@ -6220,6 +6605,24 @@ export interface components {
|
|
|
6220
6605
|
/** Value */
|
|
6221
6606
|
value: string;
|
|
6222
6607
|
};
|
|
6608
|
+
/** PostConnectionItem */
|
|
6609
|
+
app__routers__connections__PostConnectionItem: {
|
|
6610
|
+
/**
|
|
6611
|
+
* Integrationid
|
|
6612
|
+
* @description Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
6613
|
+
*/
|
|
6614
|
+
integrationid?: number;
|
|
6615
|
+
/**
|
|
6616
|
+
* Name
|
|
6617
|
+
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
6618
|
+
*/
|
|
6619
|
+
name?: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* Credentials
|
|
6622
|
+
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
6623
|
+
*/
|
|
6624
|
+
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
6625
|
+
};
|
|
6223
6626
|
/**
|
|
6224
6627
|
* Status
|
|
6225
6628
|
* @description An enumeration.
|
|
@@ -6242,6 +6645,15 @@ export interface components {
|
|
|
6242
6645
|
*/
|
|
6243
6646
|
optional?: boolean;
|
|
6244
6647
|
};
|
|
6648
|
+
/** PostConnectionItem */
|
|
6649
|
+
app__routers__integrations__PostConnectionItem: {
|
|
6650
|
+
/** Title */
|
|
6651
|
+
title: string;
|
|
6652
|
+
/** Optional */
|
|
6653
|
+
optional: boolean;
|
|
6654
|
+
/** Resource */
|
|
6655
|
+
resource: string;
|
|
6656
|
+
};
|
|
6245
6657
|
/**
|
|
6246
6658
|
* Status
|
|
6247
6659
|
* @description An enumeration.
|
|
@@ -6259,25 +6671,6 @@ export interface components {
|
|
|
6259
6671
|
/** Size */
|
|
6260
6672
|
size: number;
|
|
6261
6673
|
};
|
|
6262
|
-
/** DiscountItem */
|
|
6263
|
-
app__routers__pos__DiscountItem: {
|
|
6264
|
-
/** Name */
|
|
6265
|
-
name?: string;
|
|
6266
|
-
/** Total */
|
|
6267
|
-
total: number;
|
|
6268
|
-
};
|
|
6269
|
-
/**
|
|
6270
|
-
* PaymentStatus
|
|
6271
|
-
* @description An enumeration.
|
|
6272
|
-
* @enum {unknown}
|
|
6273
|
-
*/
|
|
6274
|
-
app__routers__pos__PaymentStatus:
|
|
6275
|
-
| 'Pending'
|
|
6276
|
-
| 'Completed'
|
|
6277
|
-
| 'Canceled'
|
|
6278
|
-
| 'Failed'
|
|
6279
|
-
| 'Unknown'
|
|
6280
|
-
| 'Authorised';
|
|
6281
6674
|
/** ProductCategoryItem */
|
|
6282
6675
|
app__routers__pos__ProductCategoryItem: {
|
|
6283
6676
|
/** Id */
|
|
@@ -6482,6 +6875,25 @@ export interface components {
|
|
|
6482
6875
|
* @enum {string}
|
|
6483
6876
|
*/
|
|
6484
6877
|
models__invoicing__VatCodeType: 'sale' | 'purchase' | 'both' | 'unknown';
|
|
6878
|
+
/** DiscountItem */
|
|
6879
|
+
models__pos_pms__DiscountItem: {
|
|
6880
|
+
/** Name */
|
|
6881
|
+
name?: string;
|
|
6882
|
+
/** Total */
|
|
6883
|
+
total: number;
|
|
6884
|
+
};
|
|
6885
|
+
/**
|
|
6886
|
+
* PaymentStatus
|
|
6887
|
+
* @description An enumeration.
|
|
6888
|
+
* @enum {unknown}
|
|
6889
|
+
*/
|
|
6890
|
+
models__pos_pms__PaymentStatus:
|
|
6891
|
+
| 'Pending'
|
|
6892
|
+
| 'Completed'
|
|
6893
|
+
| 'Canceled'
|
|
6894
|
+
| 'Failed'
|
|
6895
|
+
| 'Unknown'
|
|
6896
|
+
| 'Authorised';
|
|
6485
6897
|
};
|
|
6486
6898
|
responses: never;
|
|
6487
6899
|
parameters: never;
|
|
@@ -6690,7 +7102,7 @@ export interface operations {
|
|
|
6690
7102
|
};
|
|
6691
7103
|
requestBody?: {
|
|
6692
7104
|
content: {
|
|
6693
|
-
'application/json': components['schemas']['
|
|
7105
|
+
'application/json': components['schemas']['app__routers__connections__PostConnectionItem'];
|
|
6694
7106
|
};
|
|
6695
7107
|
};
|
|
6696
7108
|
responses: {
|
|
@@ -7583,6 +7995,40 @@ export interface operations {
|
|
|
7583
7995
|
};
|
|
7584
7996
|
};
|
|
7585
7997
|
};
|
|
7998
|
+
/** Get Bookyears */
|
|
7999
|
+
accounting_get_bookyears: {
|
|
8000
|
+
parameters: {
|
|
8001
|
+
query?: {
|
|
8002
|
+
/** @description Accounting folder ID, this needs to be passed when activating the multiple folders feature. */
|
|
8003
|
+
folder_id?: string;
|
|
8004
|
+
page?: number;
|
|
8005
|
+
size?: number;
|
|
8006
|
+
};
|
|
8007
|
+
path: {
|
|
8008
|
+
consumer_id: string;
|
|
8009
|
+
};
|
|
8010
|
+
};
|
|
8011
|
+
responses: {
|
|
8012
|
+
/** @description Successful Response */
|
|
8013
|
+
200: {
|
|
8014
|
+
content: {
|
|
8015
|
+
'application/json': components['schemas']['ChiftPage_BookYear_'];
|
|
8016
|
+
};
|
|
8017
|
+
};
|
|
8018
|
+
/** @description Bad Request */
|
|
8019
|
+
400: {
|
|
8020
|
+
content: {
|
|
8021
|
+
'application/json': components['schemas']['ChiftError'];
|
|
8022
|
+
};
|
|
8023
|
+
};
|
|
8024
|
+
/** @description Validation Error */
|
|
8025
|
+
422: {
|
|
8026
|
+
content: {
|
|
8027
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8028
|
+
};
|
|
8029
|
+
};
|
|
8030
|
+
};
|
|
8031
|
+
};
|
|
7586
8032
|
/** Get Analytic Plans */
|
|
7587
8033
|
accounting_get_analytic_plans: {
|
|
7588
8034
|
parameters: {
|
|
@@ -9409,7 +9855,7 @@ export interface operations {
|
|
|
9409
9855
|
/** @description Successful Response */
|
|
9410
9856
|
200: {
|
|
9411
9857
|
content: {
|
|
9412
|
-
'application/json': components['schemas']['
|
|
9858
|
+
'application/json': components['schemas']['ChiftPage_POSOrderItem_'];
|
|
9413
9859
|
};
|
|
9414
9860
|
};
|
|
9415
9861
|
/** @description Bad Request */
|
|
@@ -9453,7 +9899,7 @@ export interface operations {
|
|
|
9453
9899
|
/** @description Successful Response */
|
|
9454
9900
|
200: {
|
|
9455
9901
|
content: {
|
|
9456
|
-
'application/json': components['schemas']['
|
|
9902
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9457
9903
|
};
|
|
9458
9904
|
};
|
|
9459
9905
|
/** @description Bad Request */
|
|
@@ -9508,7 +9954,7 @@ export interface operations {
|
|
|
9508
9954
|
/** @description Successful Response */
|
|
9509
9955
|
200: {
|
|
9510
9956
|
content: {
|
|
9511
|
-
'application/json': components['schemas']['
|
|
9957
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9512
9958
|
};
|
|
9513
9959
|
};
|
|
9514
9960
|
/** @description Bad Request */
|
|
@@ -9604,7 +10050,7 @@ export interface operations {
|
|
|
9604
10050
|
/** @description Successful Response */
|
|
9605
10051
|
200: {
|
|
9606
10052
|
content: {
|
|
9607
|
-
'application/json': components['schemas']['
|
|
10053
|
+
'application/json': components['schemas']['ChiftPage_POSPaymentItem_'];
|
|
9608
10054
|
};
|
|
9609
10055
|
};
|
|
9610
10056
|
/** @description Bad Request */
|
|
@@ -10348,6 +10794,10 @@ export interface operations {
|
|
|
10348
10794
|
updated_after?: string;
|
|
10349
10795
|
/** @description Include detailed information concerning refunds */
|
|
10350
10796
|
include_detailed_refunds?: components['schemas']['BoolParam'];
|
|
10797
|
+
/** @description Include detailed information about categories */
|
|
10798
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10799
|
+
/** @description Include detailed information about customer */
|
|
10800
|
+
include_customer_details?: components['schemas']['BoolParam'];
|
|
10351
10801
|
page?: number;
|
|
10352
10802
|
size?: number;
|
|
10353
10803
|
};
|
|
@@ -10418,6 +10868,10 @@ export interface operations {
|
|
|
10418
10868
|
*/
|
|
10419
10869
|
ecommerce_get_order: {
|
|
10420
10870
|
parameters: {
|
|
10871
|
+
query?: {
|
|
10872
|
+
/** @description Include detailed information about categories */
|
|
10873
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10874
|
+
};
|
|
10421
10875
|
path: {
|
|
10422
10876
|
order_id: string;
|
|
10423
10877
|
consumer_id: string;
|
|
@@ -10856,13 +11310,197 @@ export interface operations {
|
|
|
10856
11310
|
};
|
|
10857
11311
|
};
|
|
10858
11312
|
/**
|
|
10859
|
-
* Retrieve one product
|
|
10860
|
-
* @description Returns a product
|
|
11313
|
+
* Retrieve one product
|
|
11314
|
+
* @description Returns a product
|
|
11315
|
+
*/
|
|
11316
|
+
invoicing_get_product: {
|
|
11317
|
+
parameters: {
|
|
11318
|
+
path: {
|
|
11319
|
+
product_id: string;
|
|
11320
|
+
consumer_id: string;
|
|
11321
|
+
};
|
|
11322
|
+
};
|
|
11323
|
+
responses: {
|
|
11324
|
+
/** @description Successful Response */
|
|
11325
|
+
200: {
|
|
11326
|
+
content: {
|
|
11327
|
+
'application/json': components['schemas']['ProductItemOut'];
|
|
11328
|
+
};
|
|
11329
|
+
};
|
|
11330
|
+
/** @description Bad Request */
|
|
11331
|
+
400: {
|
|
11332
|
+
content: {
|
|
11333
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11334
|
+
};
|
|
11335
|
+
};
|
|
11336
|
+
/** @description Not Found */
|
|
11337
|
+
404: {
|
|
11338
|
+
content: {
|
|
11339
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11340
|
+
};
|
|
11341
|
+
};
|
|
11342
|
+
/** @description Validation Error */
|
|
11343
|
+
422: {
|
|
11344
|
+
content: {
|
|
11345
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11346
|
+
};
|
|
11347
|
+
};
|
|
11348
|
+
};
|
|
11349
|
+
};
|
|
11350
|
+
/**
|
|
11351
|
+
* Retrieve all opportunities
|
|
11352
|
+
* @description Returns a list of all the opportunities
|
|
11353
|
+
*/
|
|
11354
|
+
invoicing_get_opportunities: {
|
|
11355
|
+
parameters: {
|
|
11356
|
+
query?: {
|
|
11357
|
+
page?: number;
|
|
11358
|
+
size?: number;
|
|
11359
|
+
};
|
|
11360
|
+
path: {
|
|
11361
|
+
consumer_id: string;
|
|
11362
|
+
};
|
|
11363
|
+
};
|
|
11364
|
+
responses: {
|
|
11365
|
+
/** @description Successful Response */
|
|
11366
|
+
200: {
|
|
11367
|
+
content: {
|
|
11368
|
+
'application/json': components['schemas']['ChiftPage_OpportunityItem_'];
|
|
11369
|
+
};
|
|
11370
|
+
};
|
|
11371
|
+
/** @description Bad Request */
|
|
11372
|
+
400: {
|
|
11373
|
+
content: {
|
|
11374
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11375
|
+
};
|
|
11376
|
+
};
|
|
11377
|
+
/** @description Validation Error */
|
|
11378
|
+
422: {
|
|
11379
|
+
content: {
|
|
11380
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11381
|
+
};
|
|
11382
|
+
};
|
|
11383
|
+
};
|
|
11384
|
+
};
|
|
11385
|
+
/**
|
|
11386
|
+
* Retrieve one opportunity
|
|
11387
|
+
* @description Returns an opportunity
|
|
11388
|
+
*/
|
|
11389
|
+
invoicing_get_opportunity: {
|
|
11390
|
+
parameters: {
|
|
11391
|
+
path: {
|
|
11392
|
+
opportunity_id: string;
|
|
11393
|
+
consumer_id: string;
|
|
11394
|
+
};
|
|
11395
|
+
};
|
|
11396
|
+
responses: {
|
|
11397
|
+
/** @description Successful Response */
|
|
11398
|
+
200: {
|
|
11399
|
+
content: {
|
|
11400
|
+
'application/json': components['schemas']['OpportunityItem'];
|
|
11401
|
+
};
|
|
11402
|
+
};
|
|
11403
|
+
/** @description Bad Request */
|
|
11404
|
+
400: {
|
|
11405
|
+
content: {
|
|
11406
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11407
|
+
};
|
|
11408
|
+
};
|
|
11409
|
+
/** @description Not Found */
|
|
11410
|
+
404: {
|
|
11411
|
+
content: {
|
|
11412
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11413
|
+
};
|
|
11414
|
+
};
|
|
11415
|
+
/** @description Validation Error */
|
|
11416
|
+
422: {
|
|
11417
|
+
content: {
|
|
11418
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11419
|
+
};
|
|
11420
|
+
};
|
|
11421
|
+
};
|
|
11422
|
+
};
|
|
11423
|
+
/**
|
|
11424
|
+
* Retrieve all contacts
|
|
11425
|
+
* @description Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.
|
|
11426
|
+
*/
|
|
11427
|
+
invoicing_get_contacts: {
|
|
11428
|
+
parameters: {
|
|
11429
|
+
query?: {
|
|
11430
|
+
/** @description Filter based on the type of the contact (e.g. supplier/customer/prospect). */
|
|
11431
|
+
contact_type?: components['schemas']['ContactType'];
|
|
11432
|
+
page?: number;
|
|
11433
|
+
size?: number;
|
|
11434
|
+
};
|
|
11435
|
+
path: {
|
|
11436
|
+
consumer_id: string;
|
|
11437
|
+
};
|
|
11438
|
+
};
|
|
11439
|
+
responses: {
|
|
11440
|
+
/** @description Successful Response */
|
|
11441
|
+
200: {
|
|
11442
|
+
content: {
|
|
11443
|
+
'application/json': components['schemas']['ChiftPage_ContactItemOut_'];
|
|
11444
|
+
};
|
|
11445
|
+
};
|
|
11446
|
+
/** @description Bad Request */
|
|
11447
|
+
400: {
|
|
11448
|
+
content: {
|
|
11449
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11450
|
+
};
|
|
11451
|
+
};
|
|
11452
|
+
/** @description Validation Error */
|
|
11453
|
+
422: {
|
|
11454
|
+
content: {
|
|
11455
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11456
|
+
};
|
|
11457
|
+
};
|
|
11458
|
+
};
|
|
11459
|
+
};
|
|
11460
|
+
/**
|
|
11461
|
+
* Create a contact
|
|
11462
|
+
* @description Create a new contact.
|
|
11463
|
+
*/
|
|
11464
|
+
invoicing_post_contacts: {
|
|
11465
|
+
parameters: {
|
|
11466
|
+
path: {
|
|
11467
|
+
consumer_id: string;
|
|
11468
|
+
};
|
|
11469
|
+
};
|
|
11470
|
+
requestBody: {
|
|
11471
|
+
content: {
|
|
11472
|
+
'application/json': components['schemas']['ContactItemIn'];
|
|
11473
|
+
};
|
|
11474
|
+
};
|
|
11475
|
+
responses: {
|
|
11476
|
+
/** @description Successful Response */
|
|
11477
|
+
200: {
|
|
11478
|
+
content: {
|
|
11479
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
11480
|
+
};
|
|
11481
|
+
};
|
|
11482
|
+
/** @description Bad Request */
|
|
11483
|
+
400: {
|
|
11484
|
+
content: {
|
|
11485
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11486
|
+
};
|
|
11487
|
+
};
|
|
11488
|
+
/** @description Validation Error */
|
|
11489
|
+
422: {
|
|
11490
|
+
content: {
|
|
11491
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11492
|
+
};
|
|
11493
|
+
};
|
|
11494
|
+
};
|
|
11495
|
+
};
|
|
11496
|
+
/**
|
|
11497
|
+
* Retrieve one contact
|
|
11498
|
+
* @description Returns a contact
|
|
10861
11499
|
*/
|
|
10862
|
-
|
|
11500
|
+
invoicing_get_contact: {
|
|
10863
11501
|
parameters: {
|
|
10864
11502
|
path: {
|
|
10865
|
-
|
|
11503
|
+
contact_id: string;
|
|
10866
11504
|
consumer_id: string;
|
|
10867
11505
|
};
|
|
10868
11506
|
};
|
|
@@ -10870,7 +11508,7 @@ export interface operations {
|
|
|
10870
11508
|
/** @description Successful Response */
|
|
10871
11509
|
200: {
|
|
10872
11510
|
content: {
|
|
10873
|
-
'application/json': components['schemas']['
|
|
11511
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
10874
11512
|
};
|
|
10875
11513
|
};
|
|
10876
11514
|
/** @description Bad Request */
|
|
@@ -10894,10 +11532,10 @@ export interface operations {
|
|
|
10894
11532
|
};
|
|
10895
11533
|
};
|
|
10896
11534
|
/**
|
|
10897
|
-
*
|
|
10898
|
-
* @description Returns
|
|
11535
|
+
* Get list of financial institutions
|
|
11536
|
+
* @description Returns the list of financial institutions the user consent access to
|
|
10899
11537
|
*/
|
|
10900
|
-
|
|
11538
|
+
banking_get_financial_institutions: {
|
|
10901
11539
|
parameters: {
|
|
10902
11540
|
query?: {
|
|
10903
11541
|
page?: number;
|
|
@@ -10911,7 +11549,7 @@ export interface operations {
|
|
|
10911
11549
|
/** @description Successful Response */
|
|
10912
11550
|
200: {
|
|
10913
11551
|
content: {
|
|
10914
|
-
'application/json': components['schemas']['
|
|
11552
|
+
'application/json': components['schemas']['Page_BankingFinancialInstitutionItem_'];
|
|
10915
11553
|
};
|
|
10916
11554
|
};
|
|
10917
11555
|
/** @description Bad Request */
|
|
@@ -10929,13 +11567,16 @@ export interface operations {
|
|
|
10929
11567
|
};
|
|
10930
11568
|
};
|
|
10931
11569
|
/**
|
|
10932
|
-
*
|
|
10933
|
-
* @description Returns
|
|
11570
|
+
* Get list of banking accounts
|
|
11571
|
+
* @description Returns the list of banking accounts
|
|
10934
11572
|
*/
|
|
10935
|
-
|
|
11573
|
+
banking_get_accounts: {
|
|
10936
11574
|
parameters: {
|
|
11575
|
+
query?: {
|
|
11576
|
+
page?: number;
|
|
11577
|
+
size?: number;
|
|
11578
|
+
};
|
|
10937
11579
|
path: {
|
|
10938
|
-
opportunity_id: string;
|
|
10939
11580
|
consumer_id: string;
|
|
10940
11581
|
};
|
|
10941
11582
|
};
|
|
@@ -10943,7 +11584,7 @@ export interface operations {
|
|
|
10943
11584
|
/** @description Successful Response */
|
|
10944
11585
|
200: {
|
|
10945
11586
|
content: {
|
|
10946
|
-
'application/json': components['schemas']['
|
|
11587
|
+
'application/json': components['schemas']['Page_BankingAccountItem_'];
|
|
10947
11588
|
};
|
|
10948
11589
|
};
|
|
10949
11590
|
/** @description Bad Request */
|
|
@@ -10952,12 +11593,6 @@ export interface operations {
|
|
|
10952
11593
|
'application/json': components['schemas']['ChiftError'];
|
|
10953
11594
|
};
|
|
10954
11595
|
};
|
|
10955
|
-
/** @description Not Found */
|
|
10956
|
-
404: {
|
|
10957
|
-
content: {
|
|
10958
|
-
'application/json': components['schemas']['ChiftError'];
|
|
10959
|
-
};
|
|
10960
|
-
};
|
|
10961
11596
|
/** @description Validation Error */
|
|
10962
11597
|
422: {
|
|
10963
11598
|
content: {
|
|
@@ -10967,26 +11602,28 @@ export interface operations {
|
|
|
10967
11602
|
};
|
|
10968
11603
|
};
|
|
10969
11604
|
/**
|
|
10970
|
-
*
|
|
10971
|
-
* @description Returns
|
|
11605
|
+
* Get list of financial transactions
|
|
11606
|
+
* @description Returns the list of transactions of an account
|
|
10972
11607
|
*/
|
|
10973
|
-
|
|
11608
|
+
banking_get_account_transactions: {
|
|
10974
11609
|
parameters: {
|
|
10975
11610
|
query?: {
|
|
10976
|
-
|
|
10977
|
-
|
|
11611
|
+
date_from?: string;
|
|
11612
|
+
date_to?: string;
|
|
11613
|
+
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
10978
11614
|
page?: number;
|
|
10979
11615
|
size?: number;
|
|
10980
11616
|
};
|
|
10981
11617
|
path: {
|
|
10982
11618
|
consumer_id: string;
|
|
11619
|
+
account_id: string;
|
|
10983
11620
|
};
|
|
10984
11621
|
};
|
|
10985
11622
|
responses: {
|
|
10986
11623
|
/** @description Successful Response */
|
|
10987
11624
|
200: {
|
|
10988
11625
|
content: {
|
|
10989
|
-
'application/json': components['schemas']['
|
|
11626
|
+
'application/json': components['schemas']['Page_BankingTransactionItem_'];
|
|
10990
11627
|
};
|
|
10991
11628
|
};
|
|
10992
11629
|
/** @description Bad Request */
|
|
@@ -11004,25 +11641,27 @@ export interface operations {
|
|
|
11004
11641
|
};
|
|
11005
11642
|
};
|
|
11006
11643
|
/**
|
|
11007
|
-
*
|
|
11008
|
-
* @description
|
|
11644
|
+
* Get aggregated list of account counterparts found in transactions
|
|
11645
|
+
* @description Returns the aggregated list of account counterpats found in transactions. Useful for categorisation.
|
|
11009
11646
|
*/
|
|
11010
|
-
|
|
11647
|
+
banking_get_account_counterparts: {
|
|
11011
11648
|
parameters: {
|
|
11649
|
+
query?: {
|
|
11650
|
+
accountid?: string;
|
|
11651
|
+
date_from?: string;
|
|
11652
|
+
date_to?: string;
|
|
11653
|
+
page?: number;
|
|
11654
|
+
size?: number;
|
|
11655
|
+
};
|
|
11012
11656
|
path: {
|
|
11013
11657
|
consumer_id: string;
|
|
11014
11658
|
};
|
|
11015
11659
|
};
|
|
11016
|
-
requestBody: {
|
|
11017
|
-
content: {
|
|
11018
|
-
'application/json': components['schemas']['ContactItemIn'];
|
|
11019
|
-
};
|
|
11020
|
-
};
|
|
11021
11660
|
responses: {
|
|
11022
11661
|
/** @description Successful Response */
|
|
11023
11662
|
200: {
|
|
11024
11663
|
content: {
|
|
11025
|
-
'application/json': components['schemas']['
|
|
11664
|
+
'application/json': components['schemas']['Page_BankingCounterPartItem_'];
|
|
11026
11665
|
};
|
|
11027
11666
|
};
|
|
11028
11667
|
/** @description Bad Request */
|
|
@@ -11040,13 +11679,16 @@ export interface operations {
|
|
|
11040
11679
|
};
|
|
11041
11680
|
};
|
|
11042
11681
|
/**
|
|
11043
|
-
* Retrieve
|
|
11044
|
-
* @description Returns a
|
|
11682
|
+
* Retrieve all Balances
|
|
11683
|
+
* @description Returns a list of balances.
|
|
11045
11684
|
*/
|
|
11046
|
-
|
|
11685
|
+
payment_get_balances: {
|
|
11047
11686
|
parameters: {
|
|
11687
|
+
query?: {
|
|
11688
|
+
page?: number;
|
|
11689
|
+
size?: number;
|
|
11690
|
+
};
|
|
11048
11691
|
path: {
|
|
11049
|
-
contact_id: string;
|
|
11050
11692
|
consumer_id: string;
|
|
11051
11693
|
};
|
|
11052
11694
|
};
|
|
@@ -11054,7 +11696,7 @@ export interface operations {
|
|
|
11054
11696
|
/** @description Successful Response */
|
|
11055
11697
|
200: {
|
|
11056
11698
|
content: {
|
|
11057
|
-
'application/json': components['schemas']['
|
|
11699
|
+
'application/json': components['schemas']['ChiftPage_BalanceItemOut_'];
|
|
11058
11700
|
};
|
|
11059
11701
|
};
|
|
11060
11702
|
/** @description Bad Request */
|
|
@@ -11063,8 +11705,45 @@ export interface operations {
|
|
|
11063
11705
|
'application/json': components['schemas']['ChiftError'];
|
|
11064
11706
|
};
|
|
11065
11707
|
};
|
|
11066
|
-
/** @description
|
|
11067
|
-
|
|
11708
|
+
/** @description Validation Error */
|
|
11709
|
+
422: {
|
|
11710
|
+
content: {
|
|
11711
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11712
|
+
};
|
|
11713
|
+
};
|
|
11714
|
+
};
|
|
11715
|
+
};
|
|
11716
|
+
/**
|
|
11717
|
+
* Retrieve all Transactions
|
|
11718
|
+
* @description Returns a list of transactions. Optionally transaction type and dates can be defined to retrieve transactions of a certain type from a certain date to another date
|
|
11719
|
+
*/
|
|
11720
|
+
payment_get_transaction: {
|
|
11721
|
+
parameters: {
|
|
11722
|
+
query?: {
|
|
11723
|
+
/** @description Filter based on the type of the transaction. */
|
|
11724
|
+
accounting_category?: components['schemas']['TransactionAccountingCategory'];
|
|
11725
|
+
/** @description Get all transactions more recent than this one excluded */
|
|
11726
|
+
starting_from?: string;
|
|
11727
|
+
/** @description Get all transactions for a specific balance */
|
|
11728
|
+
balance_id?: string;
|
|
11729
|
+
date_from?: string;
|
|
11730
|
+
date_to?: string;
|
|
11731
|
+
page?: number;
|
|
11732
|
+
size?: number;
|
|
11733
|
+
};
|
|
11734
|
+
path: {
|
|
11735
|
+
consumer_id: string;
|
|
11736
|
+
};
|
|
11737
|
+
};
|
|
11738
|
+
responses: {
|
|
11739
|
+
/** @description Successful Response */
|
|
11740
|
+
200: {
|
|
11741
|
+
content: {
|
|
11742
|
+
'application/json': components['schemas']['ChiftPage_TransactionItemOut_'];
|
|
11743
|
+
};
|
|
11744
|
+
};
|
|
11745
|
+
/** @description Bad Request */
|
|
11746
|
+
400: {
|
|
11068
11747
|
content: {
|
|
11069
11748
|
'application/json': components['schemas']['ChiftError'];
|
|
11070
11749
|
};
|
|
@@ -11078,12 +11757,16 @@ export interface operations {
|
|
|
11078
11757
|
};
|
|
11079
11758
|
};
|
|
11080
11759
|
/**
|
|
11081
|
-
* Get
|
|
11082
|
-
* @description Returns
|
|
11760
|
+
* Get orders (PMS)
|
|
11761
|
+
* @description Returns a list of the orders
|
|
11083
11762
|
*/
|
|
11084
|
-
|
|
11763
|
+
pms_get_orders: {
|
|
11085
11764
|
parameters: {
|
|
11086
|
-
query
|
|
11765
|
+
query: {
|
|
11766
|
+
date_from: string;
|
|
11767
|
+
date_to: string;
|
|
11768
|
+
location_id?: string;
|
|
11769
|
+
state?: components['schemas']['PMSStates'];
|
|
11087
11770
|
page?: number;
|
|
11088
11771
|
size?: number;
|
|
11089
11772
|
};
|
|
@@ -11095,7 +11778,7 @@ export interface operations {
|
|
|
11095
11778
|
/** @description Successful Response */
|
|
11096
11779
|
200: {
|
|
11097
11780
|
content: {
|
|
11098
|
-
'application/json': components['schemas']['
|
|
11781
|
+
'application/json': components['schemas']['ChiftPage_PMSOrderItem_'];
|
|
11099
11782
|
};
|
|
11100
11783
|
};
|
|
11101
11784
|
/** @description Bad Request */
|
|
@@ -11104,19 +11787,31 @@ export interface operations {
|
|
|
11104
11787
|
'application/json': components['schemas']['ChiftError'];
|
|
11105
11788
|
};
|
|
11106
11789
|
};
|
|
11790
|
+
/** @description Method Not Allowed */
|
|
11791
|
+
405: {
|
|
11792
|
+
content: {
|
|
11793
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11794
|
+
};
|
|
11795
|
+
};
|
|
11107
11796
|
/** @description Validation Error */
|
|
11108
11797
|
422: {
|
|
11109
11798
|
content: {
|
|
11110
11799
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11111
11800
|
};
|
|
11112
11801
|
};
|
|
11802
|
+
/** @description Bad Gateway */
|
|
11803
|
+
502: {
|
|
11804
|
+
content: {
|
|
11805
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11806
|
+
};
|
|
11807
|
+
};
|
|
11113
11808
|
};
|
|
11114
11809
|
};
|
|
11115
11810
|
/**
|
|
11116
|
-
* Get
|
|
11117
|
-
* @description Returns
|
|
11811
|
+
* Get locations (PMS)
|
|
11812
|
+
* @description Returns a list of the locations
|
|
11118
11813
|
*/
|
|
11119
|
-
|
|
11814
|
+
pms_get_locations: {
|
|
11120
11815
|
parameters: {
|
|
11121
11816
|
query?: {
|
|
11122
11817
|
page?: number;
|
|
@@ -11130,7 +11825,7 @@ export interface operations {
|
|
|
11130
11825
|
/** @description Successful Response */
|
|
11131
11826
|
200: {
|
|
11132
11827
|
content: {
|
|
11133
|
-
'application/json': components['schemas']['
|
|
11828
|
+
'application/json': components['schemas']['ChiftPage_PMSLocationItem_'];
|
|
11134
11829
|
};
|
|
11135
11830
|
};
|
|
11136
11831
|
/** @description Bad Request */
|
|
@@ -11139,37 +11834,47 @@ export interface operations {
|
|
|
11139
11834
|
'application/json': components['schemas']['ChiftError'];
|
|
11140
11835
|
};
|
|
11141
11836
|
};
|
|
11837
|
+
/** @description Method Not Allowed */
|
|
11838
|
+
405: {
|
|
11839
|
+
content: {
|
|
11840
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11841
|
+
};
|
|
11842
|
+
};
|
|
11142
11843
|
/** @description Validation Error */
|
|
11143
11844
|
422: {
|
|
11144
11845
|
content: {
|
|
11145
11846
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11146
11847
|
};
|
|
11147
11848
|
};
|
|
11849
|
+
/** @description Bad Gateway */
|
|
11850
|
+
502: {
|
|
11851
|
+
content: {
|
|
11852
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11853
|
+
};
|
|
11854
|
+
};
|
|
11148
11855
|
};
|
|
11149
11856
|
};
|
|
11150
11857
|
/**
|
|
11151
|
-
* Get
|
|
11152
|
-
* @description Returns
|
|
11858
|
+
* Get payments (PMS)
|
|
11859
|
+
* @description Returns a list of payments
|
|
11153
11860
|
*/
|
|
11154
|
-
|
|
11861
|
+
pms_get_payments: {
|
|
11155
11862
|
parameters: {
|
|
11156
|
-
query
|
|
11157
|
-
date_from
|
|
11158
|
-
date_to
|
|
11159
|
-
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
11863
|
+
query: {
|
|
11864
|
+
date_from: string;
|
|
11865
|
+
date_to: string;
|
|
11160
11866
|
page?: number;
|
|
11161
11867
|
size?: number;
|
|
11162
11868
|
};
|
|
11163
11869
|
path: {
|
|
11164
11870
|
consumer_id: string;
|
|
11165
|
-
account_id: string;
|
|
11166
11871
|
};
|
|
11167
11872
|
};
|
|
11168
11873
|
responses: {
|
|
11169
11874
|
/** @description Successful Response */
|
|
11170
11875
|
200: {
|
|
11171
11876
|
content: {
|
|
11172
|
-
'application/json': components['schemas']['
|
|
11877
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentItem_'];
|
|
11173
11878
|
};
|
|
11174
11879
|
};
|
|
11175
11880
|
/** @description Bad Request */
|
|
@@ -11178,24 +11883,34 @@ export interface operations {
|
|
|
11178
11883
|
'application/json': components['schemas']['ChiftError'];
|
|
11179
11884
|
};
|
|
11180
11885
|
};
|
|
11886
|
+
/** @description Method Not Allowed */
|
|
11887
|
+
405: {
|
|
11888
|
+
content: {
|
|
11889
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11890
|
+
};
|
|
11891
|
+
};
|
|
11181
11892
|
/** @description Validation Error */
|
|
11182
11893
|
422: {
|
|
11183
11894
|
content: {
|
|
11184
11895
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11185
11896
|
};
|
|
11186
11897
|
};
|
|
11898
|
+
/** @description Bad Gateway */
|
|
11899
|
+
502: {
|
|
11900
|
+
content: {
|
|
11901
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11902
|
+
};
|
|
11903
|
+
};
|
|
11187
11904
|
};
|
|
11188
11905
|
};
|
|
11189
11906
|
/**
|
|
11190
|
-
* Get
|
|
11191
|
-
* @description Returns the
|
|
11907
|
+
* Get payment methods (PMS)
|
|
11908
|
+
* @description Returns the list of payment methods
|
|
11192
11909
|
*/
|
|
11193
|
-
|
|
11910
|
+
pms_get_payments_methods: {
|
|
11194
11911
|
parameters: {
|
|
11195
11912
|
query?: {
|
|
11196
|
-
|
|
11197
|
-
date_from?: string;
|
|
11198
|
-
date_to?: string;
|
|
11913
|
+
location_id?: string;
|
|
11199
11914
|
page?: number;
|
|
11200
11915
|
size?: number;
|
|
11201
11916
|
};
|
|
@@ -11207,7 +11922,7 @@ export interface operations {
|
|
|
11207
11922
|
/** @description Successful Response */
|
|
11208
11923
|
200: {
|
|
11209
11924
|
content: {
|
|
11210
|
-
'application/json': components['schemas']['
|
|
11925
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentMethods_'];
|
|
11211
11926
|
};
|
|
11212
11927
|
};
|
|
11213
11928
|
/** @description Bad Request */
|
|
@@ -11216,19 +11931,31 @@ export interface operations {
|
|
|
11216
11931
|
'application/json': components['schemas']['ChiftError'];
|
|
11217
11932
|
};
|
|
11218
11933
|
};
|
|
11934
|
+
/** @description Method Not Allowed */
|
|
11935
|
+
405: {
|
|
11936
|
+
content: {
|
|
11937
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11938
|
+
};
|
|
11939
|
+
};
|
|
11219
11940
|
/** @description Validation Error */
|
|
11220
11941
|
422: {
|
|
11221
11942
|
content: {
|
|
11222
11943
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11223
11944
|
};
|
|
11224
11945
|
};
|
|
11946
|
+
/** @description Bad Gateway */
|
|
11947
|
+
502: {
|
|
11948
|
+
content: {
|
|
11949
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11950
|
+
};
|
|
11951
|
+
};
|
|
11225
11952
|
};
|
|
11226
11953
|
};
|
|
11227
11954
|
/**
|
|
11228
|
-
*
|
|
11229
|
-
* @description Returns a list of
|
|
11955
|
+
* Get accounting categories (PMS)
|
|
11956
|
+
* @description Returns a list of accounting categories. When not available for a specific PMS, it will return the same values as the product categories.
|
|
11230
11957
|
*/
|
|
11231
|
-
|
|
11958
|
+
pms_get_accounting_categories: {
|
|
11232
11959
|
parameters: {
|
|
11233
11960
|
query?: {
|
|
11234
11961
|
page?: number;
|
|
@@ -11242,7 +11969,7 @@ export interface operations {
|
|
|
11242
11969
|
/** @description Successful Response */
|
|
11243
11970
|
200: {
|
|
11244
11971
|
content: {
|
|
11245
|
-
'application/json': components['schemas']['
|
|
11972
|
+
'application/json': components['schemas']['ChiftPage_PMSAccountingCategoryItem_'];
|
|
11246
11973
|
};
|
|
11247
11974
|
};
|
|
11248
11975
|
/** @description Bad Request */
|
|
@@ -11251,41 +11978,45 @@ export interface operations {
|
|
|
11251
11978
|
'application/json': components['schemas']['ChiftError'];
|
|
11252
11979
|
};
|
|
11253
11980
|
};
|
|
11981
|
+
/** @description Method Not Allowed */
|
|
11982
|
+
405: {
|
|
11983
|
+
content: {
|
|
11984
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11985
|
+
};
|
|
11986
|
+
};
|
|
11254
11987
|
/** @description Validation Error */
|
|
11255
11988
|
422: {
|
|
11256
11989
|
content: {
|
|
11257
11990
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11258
11991
|
};
|
|
11259
11992
|
};
|
|
11993
|
+
/** @description Bad Gateway */
|
|
11994
|
+
502: {
|
|
11995
|
+
content: {
|
|
11996
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11997
|
+
};
|
|
11998
|
+
};
|
|
11260
11999
|
};
|
|
11261
12000
|
};
|
|
11262
12001
|
/**
|
|
11263
|
-
*
|
|
11264
|
-
* @description Returns
|
|
12002
|
+
* Get closure info for a specific day (PMS)
|
|
12003
|
+
* @description Returns whether the closure was already done for a specific day or not
|
|
11265
12004
|
*/
|
|
11266
|
-
|
|
12005
|
+
pms_get_closure: {
|
|
11267
12006
|
parameters: {
|
|
11268
12007
|
query?: {
|
|
11269
|
-
|
|
11270
|
-
accounting_category?: components['schemas']['TransactionAccountingCategory'];
|
|
11271
|
-
/** @description Get all transactions more recent than this one excluded */
|
|
11272
|
-
starting_from?: string;
|
|
11273
|
-
/** @description Get all transactions for a specific balance */
|
|
11274
|
-
balance_id?: string;
|
|
11275
|
-
date_from?: string;
|
|
11276
|
-
date_to?: string;
|
|
11277
|
-
page?: number;
|
|
11278
|
-
size?: number;
|
|
12008
|
+
location_id?: string;
|
|
11279
12009
|
};
|
|
11280
12010
|
path: {
|
|
11281
12011
|
consumer_id: string;
|
|
12012
|
+
date: string;
|
|
11282
12013
|
};
|
|
11283
12014
|
};
|
|
11284
12015
|
responses: {
|
|
11285
12016
|
/** @description Successful Response */
|
|
11286
12017
|
200: {
|
|
11287
12018
|
content: {
|
|
11288
|
-
'application/json': components['schemas']['
|
|
12019
|
+
'application/json': components['schemas']['PMSClosureItem'];
|
|
11289
12020
|
};
|
|
11290
12021
|
};
|
|
11291
12022
|
/** @description Bad Request */
|
|
@@ -11294,12 +12025,24 @@ export interface operations {
|
|
|
11294
12025
|
'application/json': components['schemas']['ChiftError'];
|
|
11295
12026
|
};
|
|
11296
12027
|
};
|
|
12028
|
+
/** @description Method Not Allowed */
|
|
12029
|
+
405: {
|
|
12030
|
+
content: {
|
|
12031
|
+
'application/json': components['schemas']['ChiftError'];
|
|
12032
|
+
};
|
|
12033
|
+
};
|
|
11297
12034
|
/** @description Validation Error */
|
|
11298
12035
|
422: {
|
|
11299
12036
|
content: {
|
|
11300
12037
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11301
12038
|
};
|
|
11302
12039
|
};
|
|
12040
|
+
/** @description Bad Gateway */
|
|
12041
|
+
502: {
|
|
12042
|
+
content: {
|
|
12043
|
+
'application/json': components['schemas']['ChiftError'];
|
|
12044
|
+
};
|
|
12045
|
+
};
|
|
11303
12046
|
};
|
|
11304
12047
|
};
|
|
11305
12048
|
/**
|