@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
|
@@ -211,6 +211,10 @@ export interface paths {
|
|
|
211
211
|
/** Get Folders */
|
|
212
212
|
get: operations['accounting_get_folders'];
|
|
213
213
|
};
|
|
214
|
+
'/consumers/{consumer_id}/accounting/bookyears': {
|
|
215
|
+
/** Get Bookyears */
|
|
216
|
+
get: operations['accounting_get_bookyears'];
|
|
217
|
+
};
|
|
214
218
|
'/consumers/{consumer_id}/accounting/analytic-plans': {
|
|
215
219
|
/** Get Analytic Plans */
|
|
216
220
|
get: operations['accounting_get_analytic_plans'];
|
|
@@ -801,6 +805,48 @@ export interface paths {
|
|
|
801
805
|
*/
|
|
802
806
|
get: operations['payment_get_transaction'];
|
|
803
807
|
};
|
|
808
|
+
'/consumers/{consumer_id}/pms/orders': {
|
|
809
|
+
/**
|
|
810
|
+
* Get orders (PMS)
|
|
811
|
+
* @description Returns a list of the orders
|
|
812
|
+
*/
|
|
813
|
+
get: operations['pms_get_orders'];
|
|
814
|
+
};
|
|
815
|
+
'/consumers/{consumer_id}/pms/locations': {
|
|
816
|
+
/**
|
|
817
|
+
* Get locations (PMS)
|
|
818
|
+
* @description Returns a list of the locations
|
|
819
|
+
*/
|
|
820
|
+
get: operations['pms_get_locations'];
|
|
821
|
+
};
|
|
822
|
+
'/consumers/{consumer_id}/pms/payments': {
|
|
823
|
+
/**
|
|
824
|
+
* Get payments (PMS)
|
|
825
|
+
* @description Returns a list of payments
|
|
826
|
+
*/
|
|
827
|
+
get: operations['pms_get_payments'];
|
|
828
|
+
};
|
|
829
|
+
'/consumers/{consumer_id}/pms/payment-methods': {
|
|
830
|
+
/**
|
|
831
|
+
* Get payment methods (PMS)
|
|
832
|
+
* @description Returns the list of payment methods
|
|
833
|
+
*/
|
|
834
|
+
get: operations['pms_get_payments_methods'];
|
|
835
|
+
};
|
|
836
|
+
'/consumers/{consumer_id}/pms/accounting-categories': {
|
|
837
|
+
/**
|
|
838
|
+
* Get accounting categories (PMS)
|
|
839
|
+
* @description Returns a list of accounting categories. When not available for a specific PMS, it will return the same values as the product categories.
|
|
840
|
+
*/
|
|
841
|
+
get: operations['pms_get_accounting_categories'];
|
|
842
|
+
};
|
|
843
|
+
'/consumers/{consumer_id}/pms/closures/{date}': {
|
|
844
|
+
/**
|
|
845
|
+
* Get closure info for a specific day (PMS)
|
|
846
|
+
* @description Returns whether the closure was already done for a specific day or not
|
|
847
|
+
*/
|
|
848
|
+
get: operations['pms_get_closure'];
|
|
849
|
+
};
|
|
804
850
|
'/token': {
|
|
805
851
|
/**
|
|
806
852
|
* Get access token
|
|
@@ -814,9 +860,15 @@ export interface components {
|
|
|
814
860
|
schemas: {
|
|
815
861
|
/** AccountBalance */
|
|
816
862
|
AccountBalance: {
|
|
817
|
-
/**
|
|
863
|
+
/**
|
|
864
|
+
* Account Number
|
|
865
|
+
* @description Number of the account
|
|
866
|
+
*/
|
|
818
867
|
account_number: string;
|
|
819
|
-
/**
|
|
868
|
+
/**
|
|
869
|
+
* Account Name
|
|
870
|
+
* @description Display name of the account
|
|
871
|
+
*/
|
|
820
872
|
account_name?: string;
|
|
821
873
|
/** Debit */
|
|
822
874
|
debit: number;
|
|
@@ -1106,7 +1158,7 @@ export interface components {
|
|
|
1106
1158
|
* @description An enumeration.
|
|
1107
1159
|
* @enum {unknown}
|
|
1108
1160
|
*/
|
|
1109
|
-
Api: 'Point of Sale' | 'eCommerce' | 'Accounting' | 'Invoicing' | 'Communication' | 'Banking' | 'Custom' | 'Payment';
|
|
1161
|
+
Api: 'Point of Sale' | 'eCommerce' | 'Accounting' | 'Invoicing' | 'Communication' | 'Banking' | 'Custom' | 'Payment' | 'Property Management System';
|
|
1110
1162
|
/** AttachmentItem */
|
|
1111
1163
|
AttachmentItem: {
|
|
1112
1164
|
/** Base64 String */
|
|
@@ -1248,6 +1300,23 @@ export interface components {
|
|
|
1248
1300
|
*/
|
|
1249
1301
|
execution_date: string;
|
|
1250
1302
|
};
|
|
1303
|
+
/** BookYear */
|
|
1304
|
+
BookYear: {
|
|
1305
|
+
/** Name */
|
|
1306
|
+
name: string;
|
|
1307
|
+
/**
|
|
1308
|
+
* Start
|
|
1309
|
+
* Format: date
|
|
1310
|
+
*/
|
|
1311
|
+
start: string;
|
|
1312
|
+
/**
|
|
1313
|
+
* End
|
|
1314
|
+
* Format: date
|
|
1315
|
+
*/
|
|
1316
|
+
end: string;
|
|
1317
|
+
/** Closed */
|
|
1318
|
+
closed: boolean;
|
|
1319
|
+
};
|
|
1251
1320
|
/**
|
|
1252
1321
|
* BoolParam
|
|
1253
1322
|
* @description An enumeration.
|
|
@@ -1394,6 +1463,17 @@ export interface components {
|
|
|
1394
1463
|
/** Size */
|
|
1395
1464
|
size: number;
|
|
1396
1465
|
};
|
|
1466
|
+
/** ChiftPage[BookYear] */
|
|
1467
|
+
ChiftPage_BookYear_: {
|
|
1468
|
+
/** Items */
|
|
1469
|
+
items: components['schemas']['BookYear'][];
|
|
1470
|
+
/** Total */
|
|
1471
|
+
total: number;
|
|
1472
|
+
/** Page */
|
|
1473
|
+
page: number;
|
|
1474
|
+
/** Size */
|
|
1475
|
+
size: number;
|
|
1476
|
+
};
|
|
1397
1477
|
/** ChiftPage[CategoryItem] */
|
|
1398
1478
|
ChiftPage_CategoryItem_: {
|
|
1399
1479
|
/** Items */
|
|
@@ -1570,10 +1650,10 @@ export interface components {
|
|
|
1570
1650
|
/** Size */
|
|
1571
1651
|
size: number;
|
|
1572
1652
|
};
|
|
1573
|
-
/** ChiftPage[
|
|
1574
|
-
|
|
1653
|
+
/** ChiftPage[OutstandingItem] */
|
|
1654
|
+
ChiftPage_OutstandingItem_: {
|
|
1575
1655
|
/** Items */
|
|
1576
|
-
items: components['schemas']['
|
|
1656
|
+
items: components['schemas']['OutstandingItem'][];
|
|
1577
1657
|
/** Total */
|
|
1578
1658
|
total: number;
|
|
1579
1659
|
/** Page */
|
|
@@ -1581,10 +1661,54 @@ export interface components {
|
|
|
1581
1661
|
/** Size */
|
|
1582
1662
|
size: number;
|
|
1583
1663
|
};
|
|
1584
|
-
/** ChiftPage[
|
|
1585
|
-
|
|
1664
|
+
/** ChiftPage[PMSAccountingCategoryItem] */
|
|
1665
|
+
ChiftPage_PMSAccountingCategoryItem_: {
|
|
1586
1666
|
/** Items */
|
|
1587
|
-
items: components['schemas']['
|
|
1667
|
+
items: components['schemas']['PMSAccountingCategoryItem'][];
|
|
1668
|
+
/** Total */
|
|
1669
|
+
total: number;
|
|
1670
|
+
/** Page */
|
|
1671
|
+
page: number;
|
|
1672
|
+
/** Size */
|
|
1673
|
+
size: number;
|
|
1674
|
+
};
|
|
1675
|
+
/** ChiftPage[PMSLocationItem] */
|
|
1676
|
+
ChiftPage_PMSLocationItem_: {
|
|
1677
|
+
/** Items */
|
|
1678
|
+
items: components['schemas']['PMSLocationItem'][];
|
|
1679
|
+
/** Total */
|
|
1680
|
+
total: number;
|
|
1681
|
+
/** Page */
|
|
1682
|
+
page: number;
|
|
1683
|
+
/** Size */
|
|
1684
|
+
size: number;
|
|
1685
|
+
};
|
|
1686
|
+
/** ChiftPage[PMSOrderItem] */
|
|
1687
|
+
ChiftPage_PMSOrderItem_: {
|
|
1688
|
+
/** Items */
|
|
1689
|
+
items: components['schemas']['PMSOrderItem'][];
|
|
1690
|
+
/** Total */
|
|
1691
|
+
total: number;
|
|
1692
|
+
/** Page */
|
|
1693
|
+
page: number;
|
|
1694
|
+
/** Size */
|
|
1695
|
+
size: number;
|
|
1696
|
+
};
|
|
1697
|
+
/** ChiftPage[PMSPaymentItem] */
|
|
1698
|
+
ChiftPage_PMSPaymentItem_: {
|
|
1699
|
+
/** Items */
|
|
1700
|
+
items: components['schemas']['PMSPaymentItem'][];
|
|
1701
|
+
/** Total */
|
|
1702
|
+
total: number;
|
|
1703
|
+
/** Page */
|
|
1704
|
+
page: number;
|
|
1705
|
+
/** Size */
|
|
1706
|
+
size: number;
|
|
1707
|
+
};
|
|
1708
|
+
/** ChiftPage[PMSPaymentMethods] */
|
|
1709
|
+
ChiftPage_PMSPaymentMethods_: {
|
|
1710
|
+
/** Items */
|
|
1711
|
+
items: components['schemas']['PMSPaymentMethods'][];
|
|
1588
1712
|
/** Total */
|
|
1589
1713
|
total: number;
|
|
1590
1714
|
/** Page */
|
|
@@ -1614,10 +1738,21 @@ export interface components {
|
|
|
1614
1738
|
/** Size */
|
|
1615
1739
|
size: number;
|
|
1616
1740
|
};
|
|
1617
|
-
/** ChiftPage[
|
|
1618
|
-
|
|
1741
|
+
/** ChiftPage[POSOrderItem] */
|
|
1742
|
+
ChiftPage_POSOrderItem_: {
|
|
1619
1743
|
/** Items */
|
|
1620
|
-
items: components['schemas']['
|
|
1744
|
+
items: components['schemas']['POSOrderItem'][];
|
|
1745
|
+
/** Total */
|
|
1746
|
+
total: number;
|
|
1747
|
+
/** Page */
|
|
1748
|
+
page: number;
|
|
1749
|
+
/** Size */
|
|
1750
|
+
size: number;
|
|
1751
|
+
};
|
|
1752
|
+
/** ChiftPage[POSPaymentItem] */
|
|
1753
|
+
ChiftPage_POSPaymentItem_: {
|
|
1754
|
+
/** Items */
|
|
1755
|
+
items: components['schemas']['POSPaymentItem'][];
|
|
1621
1756
|
/** Total */
|
|
1622
1757
|
total: number;
|
|
1623
1758
|
/** Page */
|
|
@@ -1625,10 +1760,10 @@ export interface components {
|
|
|
1625
1760
|
/** Size */
|
|
1626
1761
|
size: number;
|
|
1627
1762
|
};
|
|
1628
|
-
/** ChiftPage[
|
|
1629
|
-
|
|
1763
|
+
/** ChiftPage[POSProductItem] */
|
|
1764
|
+
ChiftPage_POSProductItem_: {
|
|
1630
1765
|
/** Items */
|
|
1631
|
-
items: components['schemas']['
|
|
1766
|
+
items: components['schemas']['POSProductItem'][];
|
|
1632
1767
|
/** Total */
|
|
1633
1768
|
total: number;
|
|
1634
1769
|
/** Page */
|
|
@@ -2877,6 +3012,10 @@ export interface components {
|
|
|
2877
3012
|
* @default true
|
|
2878
3013
|
*/
|
|
2879
3014
|
selected?: boolean;
|
|
3015
|
+
/** Vat */
|
|
3016
|
+
vat?: string;
|
|
3017
|
+
/** Company Number */
|
|
3018
|
+
company_number?: string;
|
|
2880
3019
|
};
|
|
2881
3020
|
/** GenericJournalEntry */
|
|
2882
3021
|
GenericJournalEntry: {
|
|
@@ -2994,6 +3133,12 @@ export interface components {
|
|
|
2994
3133
|
logo_url: string;
|
|
2995
3134
|
/** Icon Url */
|
|
2996
3135
|
icon_url: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* Post Connections
|
|
3138
|
+
* @description List of post-connections that can be activated for this integration.
|
|
3139
|
+
* @default []
|
|
3140
|
+
*/
|
|
3141
|
+
post_connections?: components['schemas']['app__routers__integrations__PostConnectionItem'][];
|
|
2997
3142
|
/**
|
|
2998
3143
|
* Credentials
|
|
2999
3144
|
* @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.
|
|
@@ -3169,6 +3314,8 @@ export interface components {
|
|
|
3169
3314
|
*/
|
|
3170
3315
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3171
3316
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3317
|
+
/** Shipping Country */
|
|
3318
|
+
shipping_country?: string;
|
|
3172
3319
|
/** Lines */
|
|
3173
3320
|
lines: components['schemas']['InvoiceLineItemInMonoAnalyticPlan'][];
|
|
3174
3321
|
};
|
|
@@ -3233,6 +3380,8 @@ export interface components {
|
|
|
3233
3380
|
*/
|
|
3234
3381
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3235
3382
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3383
|
+
/** Shipping Country */
|
|
3384
|
+
shipping_country?: string;
|
|
3236
3385
|
/** Lines */
|
|
3237
3386
|
lines: components['schemas']['InvoiceLineItemInMultiAnalyticPlans'][];
|
|
3238
3387
|
};
|
|
@@ -3812,38 +3961,6 @@ export interface components {
|
|
|
3812
3961
|
* @enum {string}
|
|
3813
3962
|
*/
|
|
3814
3963
|
InvoiceTypeRequest: 'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' | 'all';
|
|
3815
|
-
/** Item */
|
|
3816
|
-
Item: {
|
|
3817
|
-
/** Id */
|
|
3818
|
-
id: string;
|
|
3819
|
-
/** Quantity */
|
|
3820
|
-
quantity: number;
|
|
3821
|
-
/** Unit Price */
|
|
3822
|
-
unit_price: number;
|
|
3823
|
-
/** Total */
|
|
3824
|
-
total: number;
|
|
3825
|
-
/** Tax Amount */
|
|
3826
|
-
tax_amount: number;
|
|
3827
|
-
/** Tax Rate */
|
|
3828
|
-
tax_rate?: number;
|
|
3829
|
-
/** Description */
|
|
3830
|
-
description?: string;
|
|
3831
|
-
/**
|
|
3832
|
-
* Discounts
|
|
3833
|
-
* @default []
|
|
3834
|
-
*/
|
|
3835
|
-
discounts?: components['schemas']['app__routers__pos__DiscountItem'][];
|
|
3836
|
-
/**
|
|
3837
|
-
* Product Id
|
|
3838
|
-
* @description Reference to the product related to this item
|
|
3839
|
-
*/
|
|
3840
|
-
product_id?: string;
|
|
3841
|
-
/**
|
|
3842
|
-
* Accounting Category Id
|
|
3843
|
-
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
3844
|
-
*/
|
|
3845
|
-
accounting_category_id?: string;
|
|
3846
|
-
};
|
|
3847
3964
|
/** Journal */
|
|
3848
3965
|
Journal: {
|
|
3849
3966
|
/** Id */
|
|
@@ -4329,63 +4446,6 @@ export interface components {
|
|
|
4329
4446
|
*/
|
|
4330
4447
|
id: string;
|
|
4331
4448
|
};
|
|
4332
|
-
/** OrderItem */
|
|
4333
|
-
OrderItem: {
|
|
4334
|
-
/** Id */
|
|
4335
|
-
id: string;
|
|
4336
|
-
/** Order Number */
|
|
4337
|
-
order_number?: string;
|
|
4338
|
-
/**
|
|
4339
|
-
* Creation Date
|
|
4340
|
-
* Format: date-time
|
|
4341
|
-
*/
|
|
4342
|
-
creation_date: string;
|
|
4343
|
-
/**
|
|
4344
|
-
* Closing Date
|
|
4345
|
-
* Format: date-time
|
|
4346
|
-
*/
|
|
4347
|
-
closing_date?: string;
|
|
4348
|
-
/**
|
|
4349
|
-
* Service Date
|
|
4350
|
-
* Format: date-time
|
|
4351
|
-
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
4352
|
-
*/
|
|
4353
|
-
service_date?: string;
|
|
4354
|
-
/**
|
|
4355
|
-
* Device Id
|
|
4356
|
-
* @description ID of device that created the order
|
|
4357
|
-
*/
|
|
4358
|
-
device_id?: string;
|
|
4359
|
-
/** Total */
|
|
4360
|
-
total: number;
|
|
4361
|
-
/** Tax Amount */
|
|
4362
|
-
tax_amount: number;
|
|
4363
|
-
/** Total Discount */
|
|
4364
|
-
total_discount?: number;
|
|
4365
|
-
/** Total Refund */
|
|
4366
|
-
total_refund?: number;
|
|
4367
|
-
/**
|
|
4368
|
-
* Total Tip
|
|
4369
|
-
* @default 0
|
|
4370
|
-
*/
|
|
4371
|
-
total_tip?: number;
|
|
4372
|
-
/** Items */
|
|
4373
|
-
items: components['schemas']['Item'][];
|
|
4374
|
-
/** Payments */
|
|
4375
|
-
payments: components['schemas']['PaymentItem'][];
|
|
4376
|
-
/** Currency */
|
|
4377
|
-
currency?: string;
|
|
4378
|
-
/** Country */
|
|
4379
|
-
country?: string;
|
|
4380
|
-
/** Loyalty */
|
|
4381
|
-
loyalty?: number;
|
|
4382
|
-
/** Customer Id */
|
|
4383
|
-
customer_id?: string;
|
|
4384
|
-
/** Location Id */
|
|
4385
|
-
location_id?: string;
|
|
4386
|
-
/** Taxes */
|
|
4387
|
-
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4388
|
-
};
|
|
4389
4449
|
/** OrderItemIn */
|
|
4390
4450
|
OrderItemIn: {
|
|
4391
4451
|
customer: components['schemas']['OrderCustomerItem'];
|
|
@@ -4438,6 +4498,11 @@ export interface components {
|
|
|
4438
4498
|
* Format: date-time
|
|
4439
4499
|
*/
|
|
4440
4500
|
confirmed_on?: string;
|
|
4501
|
+
/**
|
|
4502
|
+
* Delivery Date
|
|
4503
|
+
* Format: date-time
|
|
4504
|
+
*/
|
|
4505
|
+
delivery_date?: string;
|
|
4441
4506
|
/**
|
|
4442
4507
|
* Cancelled On
|
|
4443
4508
|
* Format: date-time
|
|
@@ -4611,6 +4676,11 @@ export interface components {
|
|
|
4611
4676
|
sku?: string;
|
|
4612
4677
|
/** Name */
|
|
4613
4678
|
name: string;
|
|
4679
|
+
/**
|
|
4680
|
+
* Categories
|
|
4681
|
+
* @default []
|
|
4682
|
+
*/
|
|
4683
|
+
categories?: components['schemas']['app__routers__commerce__ProductCategoryItem'][];
|
|
4614
4684
|
};
|
|
4615
4685
|
/** OrderPaymentMethods */
|
|
4616
4686
|
OrderPaymentMethods: {
|
|
@@ -4661,13 +4731,18 @@ export interface components {
|
|
|
4661
4731
|
* @default []
|
|
4662
4732
|
*/
|
|
4663
4733
|
shipping_refunds?: components['schemas']['ShippingRefund'][];
|
|
4734
|
+
/**
|
|
4735
|
+
* Transactions
|
|
4736
|
+
* @default []
|
|
4737
|
+
*/
|
|
4738
|
+
transactions?: components['schemas']['OrderTransactions'][];
|
|
4664
4739
|
};
|
|
4665
4740
|
/**
|
|
4666
4741
|
* OrderStatus
|
|
4667
4742
|
* @description An enumeration.
|
|
4668
4743
|
* @enum {string}
|
|
4669
4744
|
*/
|
|
4670
|
-
OrderStatus: 'cancelled' | 'draft' | 'confirmed' | 'shipped' | 'refunded';
|
|
4745
|
+
OrderStatus: 'cancelled_unpaid' | 'cancelled' | 'draft' | 'confirmed' | 'shipped' | 'refunded';
|
|
4671
4746
|
/** OrderTransactions */
|
|
4672
4747
|
OrderTransactions: {
|
|
4673
4748
|
/**
|
|
@@ -4675,6 +4750,11 @@ export interface components {
|
|
|
4675
4750
|
* @description Technical id of the transaction in the eCommerce
|
|
4676
4751
|
*/
|
|
4677
4752
|
id: string;
|
|
4753
|
+
/**
|
|
4754
|
+
* Created On
|
|
4755
|
+
* Format: date-time
|
|
4756
|
+
*/
|
|
4757
|
+
created_on?: string;
|
|
4678
4758
|
/**
|
|
4679
4759
|
* Payment Method Id
|
|
4680
4760
|
* @description Technical id of the payment method in the eCommerce
|
|
@@ -4733,51 +4813,302 @@ export interface components {
|
|
|
4733
4813
|
* @enum {string}
|
|
4734
4814
|
*/
|
|
4735
4815
|
OutstandingType: 'client' | 'supplier';
|
|
4736
|
-
/**
|
|
4737
|
-
|
|
4738
|
-
/** First Name */
|
|
4739
|
-
first_name: string;
|
|
4740
|
-
/** Last Name */
|
|
4741
|
-
last_name: string;
|
|
4742
|
-
/** Phone */
|
|
4743
|
-
phone?: string;
|
|
4744
|
-
/** Email */
|
|
4745
|
-
email?: string;
|
|
4746
|
-
address?: components['schemas']['PostAddressItem'];
|
|
4747
|
-
};
|
|
4748
|
-
/** POSCustomerItem */
|
|
4749
|
-
POSCustomerItem: {
|
|
4816
|
+
/** PMSAccountingCategoryItem */
|
|
4817
|
+
PMSAccountingCategoryItem: {
|
|
4750
4818
|
/** Id */
|
|
4751
4819
|
id: string;
|
|
4752
|
-
/**
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
|
|
4820
|
+
/**
|
|
4821
|
+
* Source Ref
|
|
4822
|
+
* @description Technical id in the target software
|
|
4823
|
+
*/
|
|
4824
|
+
source_ref: components['schemas']['Ref'];
|
|
4756
4825
|
/** Name */
|
|
4757
4826
|
name: string;
|
|
4758
|
-
/** Phone */
|
|
4759
|
-
phone?: string;
|
|
4760
|
-
/** Email */
|
|
4761
|
-
email?: string;
|
|
4762
4827
|
/**
|
|
4763
|
-
*
|
|
4764
|
-
*
|
|
4828
|
+
* Id Parent
|
|
4829
|
+
* @description Indicates if the category belongs to a parent category
|
|
4765
4830
|
*/
|
|
4766
|
-
|
|
4767
|
-
/** Addresses */
|
|
4768
|
-
addresses?: components['schemas']['AddressItem'][];
|
|
4769
|
-
/** Loyalty */
|
|
4770
|
-
loyalty?: number;
|
|
4831
|
+
id_parent?: string;
|
|
4771
4832
|
/**
|
|
4772
|
-
*
|
|
4773
|
-
*
|
|
4774
|
-
* @description Birthdate
|
|
4833
|
+
* Code
|
|
4834
|
+
* @description Code assigned to the category
|
|
4775
4835
|
*/
|
|
4776
|
-
|
|
4777
|
-
|
|
4778
|
-
|
|
4779
|
-
|
|
4780
|
-
|
|
4836
|
+
code?: string;
|
|
4837
|
+
/**
|
|
4838
|
+
* Ledger Account Code
|
|
4839
|
+
* @description Ledger account code assigned to the category
|
|
4840
|
+
*/
|
|
4841
|
+
ledger_account_code?: string;
|
|
4842
|
+
/**
|
|
4843
|
+
* Posting Account Code
|
|
4844
|
+
* @description Posting account code assigned to the category
|
|
4845
|
+
*/
|
|
4846
|
+
posting_account_code?: string;
|
|
4847
|
+
};
|
|
4848
|
+
/** PMSClosureItem */
|
|
4849
|
+
PMSClosureItem: {
|
|
4850
|
+
/**
|
|
4851
|
+
* Date
|
|
4852
|
+
* Format: date
|
|
4853
|
+
*/
|
|
4854
|
+
date: string;
|
|
4855
|
+
status: components['schemas']['ClosureStates'];
|
|
4856
|
+
};
|
|
4857
|
+
/** PMSLocationItem */
|
|
4858
|
+
PMSLocationItem: {
|
|
4859
|
+
/** Id */
|
|
4860
|
+
id: string;
|
|
4861
|
+
/** Name */
|
|
4862
|
+
name: string;
|
|
4863
|
+
/**
|
|
4864
|
+
* Timezone
|
|
4865
|
+
* @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
|
|
4866
|
+
*/
|
|
4867
|
+
timezone?: string;
|
|
4868
|
+
address?: components['schemas']['AddressItem'];
|
|
4869
|
+
};
|
|
4870
|
+
/** PMSOrderItem */
|
|
4871
|
+
PMSOrderItem: {
|
|
4872
|
+
/** Id */
|
|
4873
|
+
id: string;
|
|
4874
|
+
/**
|
|
4875
|
+
* Source Ref
|
|
4876
|
+
* @description Technical id in the target software
|
|
4877
|
+
*/
|
|
4878
|
+
source_ref: components['schemas']['Ref'];
|
|
4879
|
+
/** Order Number */
|
|
4880
|
+
order_number?: string;
|
|
4881
|
+
/**
|
|
4882
|
+
* Creation Date
|
|
4883
|
+
* Format: date-time
|
|
4884
|
+
*/
|
|
4885
|
+
creation_date: string;
|
|
4886
|
+
/**
|
|
4887
|
+
* Closing Date
|
|
4888
|
+
* Format: date-time
|
|
4889
|
+
*/
|
|
4890
|
+
closing_date?: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Service Date
|
|
4893
|
+
* Format: date-time
|
|
4894
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
4895
|
+
*/
|
|
4896
|
+
service_date?: string;
|
|
4897
|
+
/**
|
|
4898
|
+
* Device Id
|
|
4899
|
+
* @description ID of device that created the order
|
|
4900
|
+
*/
|
|
4901
|
+
device_id?: string;
|
|
4902
|
+
/** Total */
|
|
4903
|
+
total: number;
|
|
4904
|
+
/** Tax Amount */
|
|
4905
|
+
tax_amount: number;
|
|
4906
|
+
/**
|
|
4907
|
+
* Total Discount
|
|
4908
|
+
* @default 0
|
|
4909
|
+
*/
|
|
4910
|
+
total_discount?: number;
|
|
4911
|
+
/**
|
|
4912
|
+
* Total Refund
|
|
4913
|
+
* @default 0
|
|
4914
|
+
*/
|
|
4915
|
+
total_refund?: number;
|
|
4916
|
+
/**
|
|
4917
|
+
* Total Tip
|
|
4918
|
+
* @default 0
|
|
4919
|
+
*/
|
|
4920
|
+
total_tip?: number;
|
|
4921
|
+
/** Currency */
|
|
4922
|
+
currency?: string;
|
|
4923
|
+
/** Country */
|
|
4924
|
+
country?: string;
|
|
4925
|
+
/** Loyalty */
|
|
4926
|
+
loyalty?: number;
|
|
4927
|
+
/** Customer Id */
|
|
4928
|
+
customer_id?: string;
|
|
4929
|
+
/** Location Id */
|
|
4930
|
+
location_id?: string;
|
|
4931
|
+
/** Taxes */
|
|
4932
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4933
|
+
/** Guests */
|
|
4934
|
+
guests?: number;
|
|
4935
|
+
/** Items */
|
|
4936
|
+
items: components['schemas']['PMSOrderLineItem'][];
|
|
4937
|
+
/**
|
|
4938
|
+
* Service Id
|
|
4939
|
+
* @description Reference to the service related to this order
|
|
4940
|
+
*/
|
|
4941
|
+
service_id?: string;
|
|
4942
|
+
};
|
|
4943
|
+
/** PMSOrderLineItem */
|
|
4944
|
+
PMSOrderLineItem: {
|
|
4945
|
+
/** Id */
|
|
4946
|
+
id: string;
|
|
4947
|
+
/**
|
|
4948
|
+
* Source Ref
|
|
4949
|
+
* @description Technical id in the target software
|
|
4950
|
+
*/
|
|
4951
|
+
source_ref: components['schemas']['Ref'];
|
|
4952
|
+
/** Quantity */
|
|
4953
|
+
quantity: number;
|
|
4954
|
+
/** Unit Price */
|
|
4955
|
+
unit_price: number;
|
|
4956
|
+
/** Total */
|
|
4957
|
+
total: number;
|
|
4958
|
+
/** Tax Amount */
|
|
4959
|
+
tax_amount: number;
|
|
4960
|
+
/** Tax Rate */
|
|
4961
|
+
tax_rate?: number;
|
|
4962
|
+
/** Description */
|
|
4963
|
+
description?: string;
|
|
4964
|
+
/**
|
|
4965
|
+
* Discounts
|
|
4966
|
+
* @default []
|
|
4967
|
+
*/
|
|
4968
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
4969
|
+
/**
|
|
4970
|
+
* Product Id
|
|
4971
|
+
* @description Reference to the product related to this item
|
|
4972
|
+
*/
|
|
4973
|
+
product_id?: string;
|
|
4974
|
+
/**
|
|
4975
|
+
* Accounting Category Id
|
|
4976
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
4977
|
+
*/
|
|
4978
|
+
accounting_category_id?: string;
|
|
4979
|
+
};
|
|
4980
|
+
/** PMSPaymentItem */
|
|
4981
|
+
PMSPaymentItem: {
|
|
4982
|
+
/** Id */
|
|
4983
|
+
id?: string;
|
|
4984
|
+
/**
|
|
4985
|
+
* Source Ref
|
|
4986
|
+
* @description Technical id in the target software
|
|
4987
|
+
*/
|
|
4988
|
+
source_ref: components['schemas']['Ref'];
|
|
4989
|
+
/** Payment Method Id */
|
|
4990
|
+
payment_method_id?: string;
|
|
4991
|
+
/** Payment Method Name */
|
|
4992
|
+
payment_method_name?: string;
|
|
4993
|
+
/** Total */
|
|
4994
|
+
total: number;
|
|
4995
|
+
/**
|
|
4996
|
+
* Tip
|
|
4997
|
+
* @default 0
|
|
4998
|
+
*/
|
|
4999
|
+
tip?: number;
|
|
5000
|
+
/** @default Unknown */
|
|
5001
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5002
|
+
/** Currency */
|
|
5003
|
+
currency?: string;
|
|
5004
|
+
/**
|
|
5005
|
+
* Date
|
|
5006
|
+
* Format: date-time
|
|
5007
|
+
*/
|
|
5008
|
+
date?: string;
|
|
5009
|
+
};
|
|
5010
|
+
/** PMSPaymentMethods */
|
|
5011
|
+
PMSPaymentMethods: {
|
|
5012
|
+
/** Id */
|
|
5013
|
+
id: string;
|
|
5014
|
+
/**
|
|
5015
|
+
* Source Ref
|
|
5016
|
+
* @description Technical id in the target software
|
|
5017
|
+
*/
|
|
5018
|
+
source_ref: components['schemas']['Ref'];
|
|
5019
|
+
/** Name */
|
|
5020
|
+
name: string;
|
|
5021
|
+
/** Extra */
|
|
5022
|
+
extra?: string;
|
|
5023
|
+
/**
|
|
5024
|
+
* Ledger Account Code
|
|
5025
|
+
* @description Ledger account code assigned to the category
|
|
5026
|
+
*/
|
|
5027
|
+
ledger_account_code?: string;
|
|
5028
|
+
};
|
|
5029
|
+
/**
|
|
5030
|
+
* PMSStates
|
|
5031
|
+
* @description An enumeration.
|
|
5032
|
+
* @enum {unknown}
|
|
5033
|
+
*/
|
|
5034
|
+
PMSStates: 'consumed' | 'closed';
|
|
5035
|
+
/** POSCreateCustomerItem */
|
|
5036
|
+
POSCreateCustomerItem: {
|
|
5037
|
+
/** First Name */
|
|
5038
|
+
first_name: string;
|
|
5039
|
+
/** Last Name */
|
|
5040
|
+
last_name: string;
|
|
5041
|
+
/** Phone */
|
|
5042
|
+
phone?: string;
|
|
5043
|
+
/** Email */
|
|
5044
|
+
email?: string;
|
|
5045
|
+
address?: components['schemas']['PostAddressItem'];
|
|
5046
|
+
};
|
|
5047
|
+
/** POSCustomerItem */
|
|
5048
|
+
POSCustomerItem: {
|
|
5049
|
+
/** Id */
|
|
5050
|
+
id: string;
|
|
5051
|
+
/** First Name */
|
|
5052
|
+
first_name?: string;
|
|
5053
|
+
/** Last Name */
|
|
5054
|
+
last_name?: string;
|
|
5055
|
+
/** Name */
|
|
5056
|
+
name: string;
|
|
5057
|
+
/** Phone */
|
|
5058
|
+
phone?: string;
|
|
5059
|
+
/** Email */
|
|
5060
|
+
email?: string;
|
|
5061
|
+
/**
|
|
5062
|
+
* Created On
|
|
5063
|
+
* Format: date-time
|
|
5064
|
+
*/
|
|
5065
|
+
created_on?: string;
|
|
5066
|
+
/** Addresses */
|
|
5067
|
+
addresses?: components['schemas']['AddressItem'][];
|
|
5068
|
+
/** Loyalty */
|
|
5069
|
+
loyalty?: number;
|
|
5070
|
+
/**
|
|
5071
|
+
* Birthdate
|
|
5072
|
+
* Format: date
|
|
5073
|
+
* @description Birthdate
|
|
5074
|
+
*/
|
|
5075
|
+
birthdate?: string;
|
|
5076
|
+
};
|
|
5077
|
+
/** POSItem */
|
|
5078
|
+
POSItem: {
|
|
5079
|
+
/** Id */
|
|
5080
|
+
id: string;
|
|
5081
|
+
/** Quantity */
|
|
5082
|
+
quantity: number;
|
|
5083
|
+
/** Unit Price */
|
|
5084
|
+
unit_price: number;
|
|
5085
|
+
/** Total */
|
|
5086
|
+
total: number;
|
|
5087
|
+
/** Tax Amount */
|
|
5088
|
+
tax_amount: number;
|
|
5089
|
+
/** Tax Rate */
|
|
5090
|
+
tax_rate?: number;
|
|
5091
|
+
/** Description */
|
|
5092
|
+
description?: string;
|
|
5093
|
+
/**
|
|
5094
|
+
* Discounts
|
|
5095
|
+
* @default []
|
|
5096
|
+
*/
|
|
5097
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
5098
|
+
/**
|
|
5099
|
+
* Product Id
|
|
5100
|
+
* @description Reference to the product related to this item
|
|
5101
|
+
*/
|
|
5102
|
+
product_id?: string;
|
|
5103
|
+
/**
|
|
5104
|
+
* Accounting Category Id
|
|
5105
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
5106
|
+
*/
|
|
5107
|
+
accounting_category_id?: string;
|
|
5108
|
+
};
|
|
5109
|
+
/** POSLocationItem */
|
|
5110
|
+
POSLocationItem: {
|
|
5111
|
+
/** Id */
|
|
4781
5112
|
id: string;
|
|
4782
5113
|
/** Name */
|
|
4783
5114
|
name: string;
|
|
@@ -4788,6 +5119,96 @@ export interface components {
|
|
|
4788
5119
|
timezone?: string;
|
|
4789
5120
|
address?: components['schemas']['AddressItem'];
|
|
4790
5121
|
};
|
|
5122
|
+
/** POSOrderItem */
|
|
5123
|
+
POSOrderItem: {
|
|
5124
|
+
/** Id */
|
|
5125
|
+
id: string;
|
|
5126
|
+
/** Order Number */
|
|
5127
|
+
order_number?: string;
|
|
5128
|
+
/**
|
|
5129
|
+
* Creation Date
|
|
5130
|
+
* Format: date-time
|
|
5131
|
+
*/
|
|
5132
|
+
creation_date: string;
|
|
5133
|
+
/**
|
|
5134
|
+
* Closing Date
|
|
5135
|
+
* Format: date-time
|
|
5136
|
+
*/
|
|
5137
|
+
closing_date?: string;
|
|
5138
|
+
/**
|
|
5139
|
+
* Service Date
|
|
5140
|
+
* Format: date-time
|
|
5141
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
5142
|
+
*/
|
|
5143
|
+
service_date?: string;
|
|
5144
|
+
/**
|
|
5145
|
+
* Device Id
|
|
5146
|
+
* @description ID of device that created the order
|
|
5147
|
+
*/
|
|
5148
|
+
device_id?: string;
|
|
5149
|
+
/** Total */
|
|
5150
|
+
total: number;
|
|
5151
|
+
/** Tax Amount */
|
|
5152
|
+
tax_amount: number;
|
|
5153
|
+
/**
|
|
5154
|
+
* Total Discount
|
|
5155
|
+
* @default 0
|
|
5156
|
+
*/
|
|
5157
|
+
total_discount?: number;
|
|
5158
|
+
/**
|
|
5159
|
+
* Total Refund
|
|
5160
|
+
* @default 0
|
|
5161
|
+
*/
|
|
5162
|
+
total_refund?: number;
|
|
5163
|
+
/**
|
|
5164
|
+
* Total Tip
|
|
5165
|
+
* @default 0
|
|
5166
|
+
*/
|
|
5167
|
+
total_tip?: number;
|
|
5168
|
+
/** Currency */
|
|
5169
|
+
currency?: string;
|
|
5170
|
+
/** Country */
|
|
5171
|
+
country?: string;
|
|
5172
|
+
/** Loyalty */
|
|
5173
|
+
loyalty?: number;
|
|
5174
|
+
/** Customer Id */
|
|
5175
|
+
customer_id?: string;
|
|
5176
|
+
/** Location Id */
|
|
5177
|
+
location_id?: string;
|
|
5178
|
+
/** Taxes */
|
|
5179
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
5180
|
+
/** Guests */
|
|
5181
|
+
guests?: number;
|
|
5182
|
+
/** Payments */
|
|
5183
|
+
payments: components['schemas']['POSPaymentItem'][];
|
|
5184
|
+
/** Items */
|
|
5185
|
+
items: components['schemas']['POSItem'][];
|
|
5186
|
+
};
|
|
5187
|
+
/** POSPaymentItem */
|
|
5188
|
+
POSPaymentItem: {
|
|
5189
|
+
/** Id */
|
|
5190
|
+
id?: string;
|
|
5191
|
+
/** Payment Method Id */
|
|
5192
|
+
payment_method_id?: string;
|
|
5193
|
+
/** Payment Method Name */
|
|
5194
|
+
payment_method_name?: string;
|
|
5195
|
+
/** Total */
|
|
5196
|
+
total: number;
|
|
5197
|
+
/**
|
|
5198
|
+
* Tip
|
|
5199
|
+
* @default 0
|
|
5200
|
+
*/
|
|
5201
|
+
tip?: number;
|
|
5202
|
+
/** @default Unknown */
|
|
5203
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5204
|
+
/** Currency */
|
|
5205
|
+
currency?: string;
|
|
5206
|
+
/**
|
|
5207
|
+
* Date
|
|
5208
|
+
* Format: date-time
|
|
5209
|
+
*/
|
|
5210
|
+
date?: string;
|
|
5211
|
+
};
|
|
4791
5212
|
/** POSProductItem */
|
|
4792
5213
|
POSProductItem: {
|
|
4793
5214
|
/** Id */
|
|
@@ -4911,31 +5332,6 @@ export interface components {
|
|
|
4911
5332
|
/** Matching Number */
|
|
4912
5333
|
matching_number?: string;
|
|
4913
5334
|
};
|
|
4914
|
-
/** PaymentItem */
|
|
4915
|
-
PaymentItem: {
|
|
4916
|
-
/** Id */
|
|
4917
|
-
id?: string;
|
|
4918
|
-
/** Payment Method Id */
|
|
4919
|
-
payment_method_id?: string;
|
|
4920
|
-
/** Payment Method Name */
|
|
4921
|
-
payment_method_name?: string;
|
|
4922
|
-
/** Total */
|
|
4923
|
-
total: number;
|
|
4924
|
-
/**
|
|
4925
|
-
* Tip
|
|
4926
|
-
* @default 0
|
|
4927
|
-
*/
|
|
4928
|
-
tip?: number;
|
|
4929
|
-
/** @default Unknown */
|
|
4930
|
-
status?: components['schemas']['app__routers__pos__PaymentStatus'];
|
|
4931
|
-
/** Currency */
|
|
4932
|
-
currency?: string;
|
|
4933
|
-
/**
|
|
4934
|
-
* Date
|
|
4935
|
-
* Format: date-time
|
|
4936
|
-
*/
|
|
4937
|
-
date?: string;
|
|
4938
|
-
};
|
|
4939
5335
|
/** PaymentMethodItem */
|
|
4940
5336
|
PaymentMethodItem: {
|
|
4941
5337
|
/**
|
|
@@ -4986,24 +5382,6 @@ export interface components {
|
|
|
4986
5382
|
/** Country */
|
|
4987
5383
|
country?: string;
|
|
4988
5384
|
};
|
|
4989
|
-
/** PostConnectionItem */
|
|
4990
|
-
PostConnectionItem: {
|
|
4991
|
-
/**
|
|
4992
|
-
* Integrationid
|
|
4993
|
-
* @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.
|
|
4994
|
-
*/
|
|
4995
|
-
integrationid?: number;
|
|
4996
|
-
/**
|
|
4997
|
-
* Name
|
|
4998
|
-
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
4999
|
-
*/
|
|
5000
|
-
name?: string;
|
|
5001
|
-
/**
|
|
5002
|
-
* Credentials
|
|
5003
|
-
* @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
|
|
5004
|
-
*/
|
|
5005
|
-
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
5006
|
-
};
|
|
5007
5385
|
/** PostConsumerItem */
|
|
5008
5386
|
PostConsumerItem: {
|
|
5009
5387
|
/** Name */
|
|
@@ -6158,17 +6536,35 @@ export interface components {
|
|
|
6158
6536
|
data?: Record<string, never>;
|
|
6159
6537
|
status: components['schemas']['app__routers__connections__Status'];
|
|
6160
6538
|
/**
|
|
6161
|
-
* Agent
|
|
6162
|
-
* @description For local agent only. Indicates whether the local agent is up and running
|
|
6539
|
+
* Agent
|
|
6540
|
+
* @description For local agent only. Indicates whether the local agent is up and running
|
|
6541
|
+
*/
|
|
6542
|
+
agent?: components['schemas']['LocalAgentInfo'];
|
|
6543
|
+
};
|
|
6544
|
+
/** CredentialItem */
|
|
6545
|
+
app__routers__connections__CredentialItem: {
|
|
6546
|
+
/** Key */
|
|
6547
|
+
key: string;
|
|
6548
|
+
/** Value */
|
|
6549
|
+
value: string;
|
|
6550
|
+
};
|
|
6551
|
+
/** PostConnectionItem */
|
|
6552
|
+
app__routers__connections__PostConnectionItem: {
|
|
6553
|
+
/**
|
|
6554
|
+
* Integrationid
|
|
6555
|
+
* @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.
|
|
6556
|
+
*/
|
|
6557
|
+
integrationid?: number;
|
|
6558
|
+
/**
|
|
6559
|
+
* Name
|
|
6560
|
+
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
6561
|
+
*/
|
|
6562
|
+
name?: string;
|
|
6563
|
+
/**
|
|
6564
|
+
* Credentials
|
|
6565
|
+
* @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
|
|
6163
6566
|
*/
|
|
6164
|
-
|
|
6165
|
-
};
|
|
6166
|
-
/** CredentialItem */
|
|
6167
|
-
app__routers__connections__CredentialItem: {
|
|
6168
|
-
/** Key */
|
|
6169
|
-
key: string;
|
|
6170
|
-
/** Value */
|
|
6171
|
-
value: string;
|
|
6567
|
+
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
6172
6568
|
};
|
|
6173
6569
|
/**
|
|
6174
6570
|
* Status
|
|
@@ -6192,6 +6588,15 @@ export interface components {
|
|
|
6192
6588
|
*/
|
|
6193
6589
|
optional?: boolean;
|
|
6194
6590
|
};
|
|
6591
|
+
/** PostConnectionItem */
|
|
6592
|
+
app__routers__integrations__PostConnectionItem: {
|
|
6593
|
+
/** Title */
|
|
6594
|
+
title: string;
|
|
6595
|
+
/** Optional */
|
|
6596
|
+
optional: boolean;
|
|
6597
|
+
/** Resource */
|
|
6598
|
+
resource: string;
|
|
6599
|
+
};
|
|
6195
6600
|
/**
|
|
6196
6601
|
* Status
|
|
6197
6602
|
* @description An enumeration.
|
|
@@ -6209,19 +6614,6 @@ export interface components {
|
|
|
6209
6614
|
/** Size */
|
|
6210
6615
|
size: number;
|
|
6211
6616
|
};
|
|
6212
|
-
/** DiscountItem */
|
|
6213
|
-
app__routers__pos__DiscountItem: {
|
|
6214
|
-
/** Name */
|
|
6215
|
-
name?: string;
|
|
6216
|
-
/** Total */
|
|
6217
|
-
total: number;
|
|
6218
|
-
};
|
|
6219
|
-
/**
|
|
6220
|
-
* PaymentStatus
|
|
6221
|
-
* @description An enumeration.
|
|
6222
|
-
* @enum {unknown}
|
|
6223
|
-
*/
|
|
6224
|
-
app__routers__pos__PaymentStatus: 'Pending' | 'Completed' | 'Canceled' | 'Failed' | 'Unknown' | 'Authorised';
|
|
6225
6617
|
/** ProductCategoryItem */
|
|
6226
6618
|
app__routers__pos__ProductCategoryItem: {
|
|
6227
6619
|
/** Id */
|
|
@@ -6422,6 +6814,19 @@ export interface components {
|
|
|
6422
6814
|
* @enum {string}
|
|
6423
6815
|
*/
|
|
6424
6816
|
models__invoicing__VatCodeType: 'sale' | 'purchase' | 'both' | 'unknown';
|
|
6817
|
+
/** DiscountItem */
|
|
6818
|
+
models__pos_pms__DiscountItem: {
|
|
6819
|
+
/** Name */
|
|
6820
|
+
name?: string;
|
|
6821
|
+
/** Total */
|
|
6822
|
+
total: number;
|
|
6823
|
+
};
|
|
6824
|
+
/**
|
|
6825
|
+
* PaymentStatus
|
|
6826
|
+
* @description An enumeration.
|
|
6827
|
+
* @enum {unknown}
|
|
6828
|
+
*/
|
|
6829
|
+
models__pos_pms__PaymentStatus: 'Pending' | 'Completed' | 'Canceled' | 'Failed' | 'Unknown' | 'Authorised';
|
|
6425
6830
|
};
|
|
6426
6831
|
responses: never;
|
|
6427
6832
|
parameters: never;
|
|
@@ -6627,7 +7032,7 @@ export interface operations {
|
|
|
6627
7032
|
};
|
|
6628
7033
|
requestBody?: {
|
|
6629
7034
|
content: {
|
|
6630
|
-
'application/json': components['schemas']['
|
|
7035
|
+
'application/json': components['schemas']['app__routers__connections__PostConnectionItem'];
|
|
6631
7036
|
};
|
|
6632
7037
|
};
|
|
6633
7038
|
responses: {
|
|
@@ -7520,6 +7925,40 @@ export interface operations {
|
|
|
7520
7925
|
};
|
|
7521
7926
|
};
|
|
7522
7927
|
};
|
|
7928
|
+
/** Get Bookyears */
|
|
7929
|
+
accounting_get_bookyears: {
|
|
7930
|
+
parameters: {
|
|
7931
|
+
query?: {
|
|
7932
|
+
/** @description Accounting folder ID, this needs to be passed when activating the multiple folders feature. */
|
|
7933
|
+
folder_id?: string;
|
|
7934
|
+
page?: number;
|
|
7935
|
+
size?: number;
|
|
7936
|
+
};
|
|
7937
|
+
path: {
|
|
7938
|
+
consumer_id: string;
|
|
7939
|
+
};
|
|
7940
|
+
};
|
|
7941
|
+
responses: {
|
|
7942
|
+
/** @description Successful Response */
|
|
7943
|
+
200: {
|
|
7944
|
+
content: {
|
|
7945
|
+
'application/json': components['schemas']['ChiftPage_BookYear_'];
|
|
7946
|
+
};
|
|
7947
|
+
};
|
|
7948
|
+
/** @description Bad Request */
|
|
7949
|
+
400: {
|
|
7950
|
+
content: {
|
|
7951
|
+
'application/json': components['schemas']['ChiftError'];
|
|
7952
|
+
};
|
|
7953
|
+
};
|
|
7954
|
+
/** @description Validation Error */
|
|
7955
|
+
422: {
|
|
7956
|
+
content: {
|
|
7957
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7958
|
+
};
|
|
7959
|
+
};
|
|
7960
|
+
};
|
|
7961
|
+
};
|
|
7523
7962
|
/** Get Analytic Plans */
|
|
7524
7963
|
accounting_get_analytic_plans: {
|
|
7525
7964
|
parameters: {
|
|
@@ -9346,7 +9785,7 @@ export interface operations {
|
|
|
9346
9785
|
/** @description Successful Response */
|
|
9347
9786
|
200: {
|
|
9348
9787
|
content: {
|
|
9349
|
-
'application/json': components['schemas']['
|
|
9788
|
+
'application/json': components['schemas']['ChiftPage_POSOrderItem_'];
|
|
9350
9789
|
};
|
|
9351
9790
|
};
|
|
9352
9791
|
/** @description Bad Request */
|
|
@@ -9390,7 +9829,7 @@ export interface operations {
|
|
|
9390
9829
|
/** @description Successful Response */
|
|
9391
9830
|
200: {
|
|
9392
9831
|
content: {
|
|
9393
|
-
'application/json': components['schemas']['
|
|
9832
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9394
9833
|
};
|
|
9395
9834
|
};
|
|
9396
9835
|
/** @description Bad Request */
|
|
@@ -9445,7 +9884,7 @@ export interface operations {
|
|
|
9445
9884
|
/** @description Successful Response */
|
|
9446
9885
|
200: {
|
|
9447
9886
|
content: {
|
|
9448
|
-
'application/json': components['schemas']['
|
|
9887
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9449
9888
|
};
|
|
9450
9889
|
};
|
|
9451
9890
|
/** @description Bad Request */
|
|
@@ -9541,7 +9980,7 @@ export interface operations {
|
|
|
9541
9980
|
/** @description Successful Response */
|
|
9542
9981
|
200: {
|
|
9543
9982
|
content: {
|
|
9544
|
-
'application/json': components['schemas']['
|
|
9983
|
+
'application/json': components['schemas']['ChiftPage_POSPaymentItem_'];
|
|
9545
9984
|
};
|
|
9546
9985
|
};
|
|
9547
9986
|
/** @description Bad Request */
|
|
@@ -10285,6 +10724,10 @@ export interface operations {
|
|
|
10285
10724
|
updated_after?: string;
|
|
10286
10725
|
/** @description Include detailed information concerning refunds */
|
|
10287
10726
|
include_detailed_refunds?: components['schemas']['BoolParam'];
|
|
10727
|
+
/** @description Include detailed information about categories */
|
|
10728
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10729
|
+
/** @description Include detailed information about customer */
|
|
10730
|
+
include_customer_details?: components['schemas']['BoolParam'];
|
|
10288
10731
|
page?: number;
|
|
10289
10732
|
size?: number;
|
|
10290
10733
|
};
|
|
@@ -10355,6 +10798,10 @@ export interface operations {
|
|
|
10355
10798
|
*/
|
|
10356
10799
|
ecommerce_get_order: {
|
|
10357
10800
|
parameters: {
|
|
10801
|
+
query?: {
|
|
10802
|
+
/** @description Include detailed information about categories */
|
|
10803
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10804
|
+
};
|
|
10358
10805
|
path: {
|
|
10359
10806
|
order_id: string;
|
|
10360
10807
|
consumer_id: string;
|
|
@@ -10793,13 +11240,197 @@ export interface operations {
|
|
|
10793
11240
|
};
|
|
10794
11241
|
};
|
|
10795
11242
|
/**
|
|
10796
|
-
* Retrieve one product
|
|
10797
|
-
* @description Returns a product
|
|
11243
|
+
* Retrieve one product
|
|
11244
|
+
* @description Returns a product
|
|
11245
|
+
*/
|
|
11246
|
+
invoicing_get_product: {
|
|
11247
|
+
parameters: {
|
|
11248
|
+
path: {
|
|
11249
|
+
product_id: string;
|
|
11250
|
+
consumer_id: string;
|
|
11251
|
+
};
|
|
11252
|
+
};
|
|
11253
|
+
responses: {
|
|
11254
|
+
/** @description Successful Response */
|
|
11255
|
+
200: {
|
|
11256
|
+
content: {
|
|
11257
|
+
'application/json': components['schemas']['ProductItemOut'];
|
|
11258
|
+
};
|
|
11259
|
+
};
|
|
11260
|
+
/** @description Bad Request */
|
|
11261
|
+
400: {
|
|
11262
|
+
content: {
|
|
11263
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11264
|
+
};
|
|
11265
|
+
};
|
|
11266
|
+
/** @description Not Found */
|
|
11267
|
+
404: {
|
|
11268
|
+
content: {
|
|
11269
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11270
|
+
};
|
|
11271
|
+
};
|
|
11272
|
+
/** @description Validation Error */
|
|
11273
|
+
422: {
|
|
11274
|
+
content: {
|
|
11275
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11276
|
+
};
|
|
11277
|
+
};
|
|
11278
|
+
};
|
|
11279
|
+
};
|
|
11280
|
+
/**
|
|
11281
|
+
* Retrieve all opportunities
|
|
11282
|
+
* @description Returns a list of all the opportunities
|
|
11283
|
+
*/
|
|
11284
|
+
invoicing_get_opportunities: {
|
|
11285
|
+
parameters: {
|
|
11286
|
+
query?: {
|
|
11287
|
+
page?: number;
|
|
11288
|
+
size?: number;
|
|
11289
|
+
};
|
|
11290
|
+
path: {
|
|
11291
|
+
consumer_id: string;
|
|
11292
|
+
};
|
|
11293
|
+
};
|
|
11294
|
+
responses: {
|
|
11295
|
+
/** @description Successful Response */
|
|
11296
|
+
200: {
|
|
11297
|
+
content: {
|
|
11298
|
+
'application/json': components['schemas']['ChiftPage_OpportunityItem_'];
|
|
11299
|
+
};
|
|
11300
|
+
};
|
|
11301
|
+
/** @description Bad Request */
|
|
11302
|
+
400: {
|
|
11303
|
+
content: {
|
|
11304
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11305
|
+
};
|
|
11306
|
+
};
|
|
11307
|
+
/** @description Validation Error */
|
|
11308
|
+
422: {
|
|
11309
|
+
content: {
|
|
11310
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11311
|
+
};
|
|
11312
|
+
};
|
|
11313
|
+
};
|
|
11314
|
+
};
|
|
11315
|
+
/**
|
|
11316
|
+
* Retrieve one opportunity
|
|
11317
|
+
* @description Returns an opportunity
|
|
11318
|
+
*/
|
|
11319
|
+
invoicing_get_opportunity: {
|
|
11320
|
+
parameters: {
|
|
11321
|
+
path: {
|
|
11322
|
+
opportunity_id: string;
|
|
11323
|
+
consumer_id: string;
|
|
11324
|
+
};
|
|
11325
|
+
};
|
|
11326
|
+
responses: {
|
|
11327
|
+
/** @description Successful Response */
|
|
11328
|
+
200: {
|
|
11329
|
+
content: {
|
|
11330
|
+
'application/json': components['schemas']['OpportunityItem'];
|
|
11331
|
+
};
|
|
11332
|
+
};
|
|
11333
|
+
/** @description Bad Request */
|
|
11334
|
+
400: {
|
|
11335
|
+
content: {
|
|
11336
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11337
|
+
};
|
|
11338
|
+
};
|
|
11339
|
+
/** @description Not Found */
|
|
11340
|
+
404: {
|
|
11341
|
+
content: {
|
|
11342
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11343
|
+
};
|
|
11344
|
+
};
|
|
11345
|
+
/** @description Validation Error */
|
|
11346
|
+
422: {
|
|
11347
|
+
content: {
|
|
11348
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11349
|
+
};
|
|
11350
|
+
};
|
|
11351
|
+
};
|
|
11352
|
+
};
|
|
11353
|
+
/**
|
|
11354
|
+
* Retrieve all contacts
|
|
11355
|
+
* @description Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.
|
|
11356
|
+
*/
|
|
11357
|
+
invoicing_get_contacts: {
|
|
11358
|
+
parameters: {
|
|
11359
|
+
query?: {
|
|
11360
|
+
/** @description Filter based on the type of the contact (e.g. supplier/customer/prospect). */
|
|
11361
|
+
contact_type?: components['schemas']['ContactType'];
|
|
11362
|
+
page?: number;
|
|
11363
|
+
size?: number;
|
|
11364
|
+
};
|
|
11365
|
+
path: {
|
|
11366
|
+
consumer_id: string;
|
|
11367
|
+
};
|
|
11368
|
+
};
|
|
11369
|
+
responses: {
|
|
11370
|
+
/** @description Successful Response */
|
|
11371
|
+
200: {
|
|
11372
|
+
content: {
|
|
11373
|
+
'application/json': components['schemas']['ChiftPage_ContactItemOut_'];
|
|
11374
|
+
};
|
|
11375
|
+
};
|
|
11376
|
+
/** @description Bad Request */
|
|
11377
|
+
400: {
|
|
11378
|
+
content: {
|
|
11379
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11380
|
+
};
|
|
11381
|
+
};
|
|
11382
|
+
/** @description Validation Error */
|
|
11383
|
+
422: {
|
|
11384
|
+
content: {
|
|
11385
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11386
|
+
};
|
|
11387
|
+
};
|
|
11388
|
+
};
|
|
11389
|
+
};
|
|
11390
|
+
/**
|
|
11391
|
+
* Create a contact
|
|
11392
|
+
* @description Create a new contact.
|
|
11393
|
+
*/
|
|
11394
|
+
invoicing_post_contacts: {
|
|
11395
|
+
parameters: {
|
|
11396
|
+
path: {
|
|
11397
|
+
consumer_id: string;
|
|
11398
|
+
};
|
|
11399
|
+
};
|
|
11400
|
+
requestBody: {
|
|
11401
|
+
content: {
|
|
11402
|
+
'application/json': components['schemas']['ContactItemIn'];
|
|
11403
|
+
};
|
|
11404
|
+
};
|
|
11405
|
+
responses: {
|
|
11406
|
+
/** @description Successful Response */
|
|
11407
|
+
200: {
|
|
11408
|
+
content: {
|
|
11409
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
11410
|
+
};
|
|
11411
|
+
};
|
|
11412
|
+
/** @description Bad Request */
|
|
11413
|
+
400: {
|
|
11414
|
+
content: {
|
|
11415
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11416
|
+
};
|
|
11417
|
+
};
|
|
11418
|
+
/** @description Validation Error */
|
|
11419
|
+
422: {
|
|
11420
|
+
content: {
|
|
11421
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11422
|
+
};
|
|
11423
|
+
};
|
|
11424
|
+
};
|
|
11425
|
+
};
|
|
11426
|
+
/**
|
|
11427
|
+
* Retrieve one contact
|
|
11428
|
+
* @description Returns a contact
|
|
10798
11429
|
*/
|
|
10799
|
-
|
|
11430
|
+
invoicing_get_contact: {
|
|
10800
11431
|
parameters: {
|
|
10801
11432
|
path: {
|
|
10802
|
-
|
|
11433
|
+
contact_id: string;
|
|
10803
11434
|
consumer_id: string;
|
|
10804
11435
|
};
|
|
10805
11436
|
};
|
|
@@ -10807,7 +11438,7 @@ export interface operations {
|
|
|
10807
11438
|
/** @description Successful Response */
|
|
10808
11439
|
200: {
|
|
10809
11440
|
content: {
|
|
10810
|
-
'application/json': components['schemas']['
|
|
11441
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
10811
11442
|
};
|
|
10812
11443
|
};
|
|
10813
11444
|
/** @description Bad Request */
|
|
@@ -10831,10 +11462,10 @@ export interface operations {
|
|
|
10831
11462
|
};
|
|
10832
11463
|
};
|
|
10833
11464
|
/**
|
|
10834
|
-
*
|
|
10835
|
-
* @description Returns
|
|
11465
|
+
* Get list of financial institutions
|
|
11466
|
+
* @description Returns the list of financial institutions the user consent access to
|
|
10836
11467
|
*/
|
|
10837
|
-
|
|
11468
|
+
banking_get_financial_institutions: {
|
|
10838
11469
|
parameters: {
|
|
10839
11470
|
query?: {
|
|
10840
11471
|
page?: number;
|
|
@@ -10848,7 +11479,7 @@ export interface operations {
|
|
|
10848
11479
|
/** @description Successful Response */
|
|
10849
11480
|
200: {
|
|
10850
11481
|
content: {
|
|
10851
|
-
'application/json': components['schemas']['
|
|
11482
|
+
'application/json': components['schemas']['Page_BankingFinancialInstitutionItem_'];
|
|
10852
11483
|
};
|
|
10853
11484
|
};
|
|
10854
11485
|
/** @description Bad Request */
|
|
@@ -10866,13 +11497,16 @@ export interface operations {
|
|
|
10866
11497
|
};
|
|
10867
11498
|
};
|
|
10868
11499
|
/**
|
|
10869
|
-
*
|
|
10870
|
-
* @description Returns
|
|
11500
|
+
* Get list of banking accounts
|
|
11501
|
+
* @description Returns the list of banking accounts
|
|
10871
11502
|
*/
|
|
10872
|
-
|
|
11503
|
+
banking_get_accounts: {
|
|
10873
11504
|
parameters: {
|
|
11505
|
+
query?: {
|
|
11506
|
+
page?: number;
|
|
11507
|
+
size?: number;
|
|
11508
|
+
};
|
|
10874
11509
|
path: {
|
|
10875
|
-
opportunity_id: string;
|
|
10876
11510
|
consumer_id: string;
|
|
10877
11511
|
};
|
|
10878
11512
|
};
|
|
@@ -10880,7 +11514,7 @@ export interface operations {
|
|
|
10880
11514
|
/** @description Successful Response */
|
|
10881
11515
|
200: {
|
|
10882
11516
|
content: {
|
|
10883
|
-
'application/json': components['schemas']['
|
|
11517
|
+
'application/json': components['schemas']['Page_BankingAccountItem_'];
|
|
10884
11518
|
};
|
|
10885
11519
|
};
|
|
10886
11520
|
/** @description Bad Request */
|
|
@@ -10889,12 +11523,6 @@ export interface operations {
|
|
|
10889
11523
|
'application/json': components['schemas']['ChiftError'];
|
|
10890
11524
|
};
|
|
10891
11525
|
};
|
|
10892
|
-
/** @description Not Found */
|
|
10893
|
-
404: {
|
|
10894
|
-
content: {
|
|
10895
|
-
'application/json': components['schemas']['ChiftError'];
|
|
10896
|
-
};
|
|
10897
|
-
};
|
|
10898
11526
|
/** @description Validation Error */
|
|
10899
11527
|
422: {
|
|
10900
11528
|
content: {
|
|
@@ -10904,26 +11532,28 @@ export interface operations {
|
|
|
10904
11532
|
};
|
|
10905
11533
|
};
|
|
10906
11534
|
/**
|
|
10907
|
-
*
|
|
10908
|
-
* @description Returns
|
|
11535
|
+
* Get list of financial transactions
|
|
11536
|
+
* @description Returns the list of transactions of an account
|
|
10909
11537
|
*/
|
|
10910
|
-
|
|
11538
|
+
banking_get_account_transactions: {
|
|
10911
11539
|
parameters: {
|
|
10912
11540
|
query?: {
|
|
10913
|
-
|
|
10914
|
-
|
|
11541
|
+
date_from?: string;
|
|
11542
|
+
date_to?: string;
|
|
11543
|
+
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
10915
11544
|
page?: number;
|
|
10916
11545
|
size?: number;
|
|
10917
11546
|
};
|
|
10918
11547
|
path: {
|
|
10919
11548
|
consumer_id: string;
|
|
11549
|
+
account_id: string;
|
|
10920
11550
|
};
|
|
10921
11551
|
};
|
|
10922
11552
|
responses: {
|
|
10923
11553
|
/** @description Successful Response */
|
|
10924
11554
|
200: {
|
|
10925
11555
|
content: {
|
|
10926
|
-
'application/json': components['schemas']['
|
|
11556
|
+
'application/json': components['schemas']['Page_BankingTransactionItem_'];
|
|
10927
11557
|
};
|
|
10928
11558
|
};
|
|
10929
11559
|
/** @description Bad Request */
|
|
@@ -10941,25 +11571,27 @@ export interface operations {
|
|
|
10941
11571
|
};
|
|
10942
11572
|
};
|
|
10943
11573
|
/**
|
|
10944
|
-
*
|
|
10945
|
-
* @description
|
|
11574
|
+
* Get aggregated list of account counterparts found in transactions
|
|
11575
|
+
* @description Returns the aggregated list of account counterpats found in transactions. Useful for categorisation.
|
|
10946
11576
|
*/
|
|
10947
|
-
|
|
11577
|
+
banking_get_account_counterparts: {
|
|
10948
11578
|
parameters: {
|
|
11579
|
+
query?: {
|
|
11580
|
+
accountid?: string;
|
|
11581
|
+
date_from?: string;
|
|
11582
|
+
date_to?: string;
|
|
11583
|
+
page?: number;
|
|
11584
|
+
size?: number;
|
|
11585
|
+
};
|
|
10949
11586
|
path: {
|
|
10950
11587
|
consumer_id: string;
|
|
10951
11588
|
};
|
|
10952
11589
|
};
|
|
10953
|
-
requestBody: {
|
|
10954
|
-
content: {
|
|
10955
|
-
'application/json': components['schemas']['ContactItemIn'];
|
|
10956
|
-
};
|
|
10957
|
-
};
|
|
10958
11590
|
responses: {
|
|
10959
11591
|
/** @description Successful Response */
|
|
10960
11592
|
200: {
|
|
10961
11593
|
content: {
|
|
10962
|
-
'application/json': components['schemas']['
|
|
11594
|
+
'application/json': components['schemas']['Page_BankingCounterPartItem_'];
|
|
10963
11595
|
};
|
|
10964
11596
|
};
|
|
10965
11597
|
/** @description Bad Request */
|
|
@@ -10977,13 +11609,16 @@ export interface operations {
|
|
|
10977
11609
|
};
|
|
10978
11610
|
};
|
|
10979
11611
|
/**
|
|
10980
|
-
* Retrieve
|
|
10981
|
-
* @description Returns a
|
|
11612
|
+
* Retrieve all Balances
|
|
11613
|
+
* @description Returns a list of balances.
|
|
10982
11614
|
*/
|
|
10983
|
-
|
|
11615
|
+
payment_get_balances: {
|
|
10984
11616
|
parameters: {
|
|
11617
|
+
query?: {
|
|
11618
|
+
page?: number;
|
|
11619
|
+
size?: number;
|
|
11620
|
+
};
|
|
10985
11621
|
path: {
|
|
10986
|
-
contact_id: string;
|
|
10987
11622
|
consumer_id: string;
|
|
10988
11623
|
};
|
|
10989
11624
|
};
|
|
@@ -10991,7 +11626,7 @@ export interface operations {
|
|
|
10991
11626
|
/** @description Successful Response */
|
|
10992
11627
|
200: {
|
|
10993
11628
|
content: {
|
|
10994
|
-
'application/json': components['schemas']['
|
|
11629
|
+
'application/json': components['schemas']['ChiftPage_BalanceItemOut_'];
|
|
10995
11630
|
};
|
|
10996
11631
|
};
|
|
10997
11632
|
/** @description Bad Request */
|
|
@@ -11000,8 +11635,45 @@ export interface operations {
|
|
|
11000
11635
|
'application/json': components['schemas']['ChiftError'];
|
|
11001
11636
|
};
|
|
11002
11637
|
};
|
|
11003
|
-
/** @description
|
|
11004
|
-
|
|
11638
|
+
/** @description Validation Error */
|
|
11639
|
+
422: {
|
|
11640
|
+
content: {
|
|
11641
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11642
|
+
};
|
|
11643
|
+
};
|
|
11644
|
+
};
|
|
11645
|
+
};
|
|
11646
|
+
/**
|
|
11647
|
+
* Retrieve all Transactions
|
|
11648
|
+
* @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
|
|
11649
|
+
*/
|
|
11650
|
+
payment_get_transaction: {
|
|
11651
|
+
parameters: {
|
|
11652
|
+
query?: {
|
|
11653
|
+
/** @description Filter based on the type of the transaction. */
|
|
11654
|
+
accounting_category?: components['schemas']['TransactionAccountingCategory'];
|
|
11655
|
+
/** @description Get all transactions more recent than this one excluded */
|
|
11656
|
+
starting_from?: string;
|
|
11657
|
+
/** @description Get all transactions for a specific balance */
|
|
11658
|
+
balance_id?: string;
|
|
11659
|
+
date_from?: string;
|
|
11660
|
+
date_to?: string;
|
|
11661
|
+
page?: number;
|
|
11662
|
+
size?: number;
|
|
11663
|
+
};
|
|
11664
|
+
path: {
|
|
11665
|
+
consumer_id: string;
|
|
11666
|
+
};
|
|
11667
|
+
};
|
|
11668
|
+
responses: {
|
|
11669
|
+
/** @description Successful Response */
|
|
11670
|
+
200: {
|
|
11671
|
+
content: {
|
|
11672
|
+
'application/json': components['schemas']['ChiftPage_TransactionItemOut_'];
|
|
11673
|
+
};
|
|
11674
|
+
};
|
|
11675
|
+
/** @description Bad Request */
|
|
11676
|
+
400: {
|
|
11005
11677
|
content: {
|
|
11006
11678
|
'application/json': components['schemas']['ChiftError'];
|
|
11007
11679
|
};
|
|
@@ -11015,12 +11687,16 @@ export interface operations {
|
|
|
11015
11687
|
};
|
|
11016
11688
|
};
|
|
11017
11689
|
/**
|
|
11018
|
-
* Get
|
|
11019
|
-
* @description Returns
|
|
11690
|
+
* Get orders (PMS)
|
|
11691
|
+
* @description Returns a list of the orders
|
|
11020
11692
|
*/
|
|
11021
|
-
|
|
11693
|
+
pms_get_orders: {
|
|
11022
11694
|
parameters: {
|
|
11023
|
-
query
|
|
11695
|
+
query: {
|
|
11696
|
+
date_from: string;
|
|
11697
|
+
date_to: string;
|
|
11698
|
+
location_id?: string;
|
|
11699
|
+
state?: components['schemas']['PMSStates'];
|
|
11024
11700
|
page?: number;
|
|
11025
11701
|
size?: number;
|
|
11026
11702
|
};
|
|
@@ -11032,7 +11708,7 @@ export interface operations {
|
|
|
11032
11708
|
/** @description Successful Response */
|
|
11033
11709
|
200: {
|
|
11034
11710
|
content: {
|
|
11035
|
-
'application/json': components['schemas']['
|
|
11711
|
+
'application/json': components['schemas']['ChiftPage_PMSOrderItem_'];
|
|
11036
11712
|
};
|
|
11037
11713
|
};
|
|
11038
11714
|
/** @description Bad Request */
|
|
@@ -11041,19 +11717,31 @@ export interface operations {
|
|
|
11041
11717
|
'application/json': components['schemas']['ChiftError'];
|
|
11042
11718
|
};
|
|
11043
11719
|
};
|
|
11720
|
+
/** @description Method Not Allowed */
|
|
11721
|
+
405: {
|
|
11722
|
+
content: {
|
|
11723
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11724
|
+
};
|
|
11725
|
+
};
|
|
11044
11726
|
/** @description Validation Error */
|
|
11045
11727
|
422: {
|
|
11046
11728
|
content: {
|
|
11047
11729
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11048
11730
|
};
|
|
11049
11731
|
};
|
|
11732
|
+
/** @description Bad Gateway */
|
|
11733
|
+
502: {
|
|
11734
|
+
content: {
|
|
11735
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11736
|
+
};
|
|
11737
|
+
};
|
|
11050
11738
|
};
|
|
11051
11739
|
};
|
|
11052
11740
|
/**
|
|
11053
|
-
* Get
|
|
11054
|
-
* @description Returns
|
|
11741
|
+
* Get locations (PMS)
|
|
11742
|
+
* @description Returns a list of the locations
|
|
11055
11743
|
*/
|
|
11056
|
-
|
|
11744
|
+
pms_get_locations: {
|
|
11057
11745
|
parameters: {
|
|
11058
11746
|
query?: {
|
|
11059
11747
|
page?: number;
|
|
@@ -11067,7 +11755,7 @@ export interface operations {
|
|
|
11067
11755
|
/** @description Successful Response */
|
|
11068
11756
|
200: {
|
|
11069
11757
|
content: {
|
|
11070
|
-
'application/json': components['schemas']['
|
|
11758
|
+
'application/json': components['schemas']['ChiftPage_PMSLocationItem_'];
|
|
11071
11759
|
};
|
|
11072
11760
|
};
|
|
11073
11761
|
/** @description Bad Request */
|
|
@@ -11076,37 +11764,47 @@ export interface operations {
|
|
|
11076
11764
|
'application/json': components['schemas']['ChiftError'];
|
|
11077
11765
|
};
|
|
11078
11766
|
};
|
|
11767
|
+
/** @description Method Not Allowed */
|
|
11768
|
+
405: {
|
|
11769
|
+
content: {
|
|
11770
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11771
|
+
};
|
|
11772
|
+
};
|
|
11079
11773
|
/** @description Validation Error */
|
|
11080
11774
|
422: {
|
|
11081
11775
|
content: {
|
|
11082
11776
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11083
11777
|
};
|
|
11084
11778
|
};
|
|
11779
|
+
/** @description Bad Gateway */
|
|
11780
|
+
502: {
|
|
11781
|
+
content: {
|
|
11782
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11783
|
+
};
|
|
11784
|
+
};
|
|
11085
11785
|
};
|
|
11086
11786
|
};
|
|
11087
11787
|
/**
|
|
11088
|
-
* Get
|
|
11089
|
-
* @description Returns
|
|
11788
|
+
* Get payments (PMS)
|
|
11789
|
+
* @description Returns a list of payments
|
|
11090
11790
|
*/
|
|
11091
|
-
|
|
11791
|
+
pms_get_payments: {
|
|
11092
11792
|
parameters: {
|
|
11093
|
-
query
|
|
11094
|
-
date_from
|
|
11095
|
-
date_to
|
|
11096
|
-
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
11793
|
+
query: {
|
|
11794
|
+
date_from: string;
|
|
11795
|
+
date_to: string;
|
|
11097
11796
|
page?: number;
|
|
11098
11797
|
size?: number;
|
|
11099
11798
|
};
|
|
11100
11799
|
path: {
|
|
11101
11800
|
consumer_id: string;
|
|
11102
|
-
account_id: string;
|
|
11103
11801
|
};
|
|
11104
11802
|
};
|
|
11105
11803
|
responses: {
|
|
11106
11804
|
/** @description Successful Response */
|
|
11107
11805
|
200: {
|
|
11108
11806
|
content: {
|
|
11109
|
-
'application/json': components['schemas']['
|
|
11807
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentItem_'];
|
|
11110
11808
|
};
|
|
11111
11809
|
};
|
|
11112
11810
|
/** @description Bad Request */
|
|
@@ -11115,24 +11813,34 @@ export interface operations {
|
|
|
11115
11813
|
'application/json': components['schemas']['ChiftError'];
|
|
11116
11814
|
};
|
|
11117
11815
|
};
|
|
11816
|
+
/** @description Method Not Allowed */
|
|
11817
|
+
405: {
|
|
11818
|
+
content: {
|
|
11819
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11820
|
+
};
|
|
11821
|
+
};
|
|
11118
11822
|
/** @description Validation Error */
|
|
11119
11823
|
422: {
|
|
11120
11824
|
content: {
|
|
11121
11825
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11122
11826
|
};
|
|
11123
11827
|
};
|
|
11828
|
+
/** @description Bad Gateway */
|
|
11829
|
+
502: {
|
|
11830
|
+
content: {
|
|
11831
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11832
|
+
};
|
|
11833
|
+
};
|
|
11124
11834
|
};
|
|
11125
11835
|
};
|
|
11126
11836
|
/**
|
|
11127
|
-
* Get
|
|
11128
|
-
* @description Returns the
|
|
11837
|
+
* Get payment methods (PMS)
|
|
11838
|
+
* @description Returns the list of payment methods
|
|
11129
11839
|
*/
|
|
11130
|
-
|
|
11840
|
+
pms_get_payments_methods: {
|
|
11131
11841
|
parameters: {
|
|
11132
11842
|
query?: {
|
|
11133
|
-
|
|
11134
|
-
date_from?: string;
|
|
11135
|
-
date_to?: string;
|
|
11843
|
+
location_id?: string;
|
|
11136
11844
|
page?: number;
|
|
11137
11845
|
size?: number;
|
|
11138
11846
|
};
|
|
@@ -11144,7 +11852,7 @@ export interface operations {
|
|
|
11144
11852
|
/** @description Successful Response */
|
|
11145
11853
|
200: {
|
|
11146
11854
|
content: {
|
|
11147
|
-
'application/json': components['schemas']['
|
|
11855
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentMethods_'];
|
|
11148
11856
|
};
|
|
11149
11857
|
};
|
|
11150
11858
|
/** @description Bad Request */
|
|
@@ -11153,19 +11861,31 @@ export interface operations {
|
|
|
11153
11861
|
'application/json': components['schemas']['ChiftError'];
|
|
11154
11862
|
};
|
|
11155
11863
|
};
|
|
11864
|
+
/** @description Method Not Allowed */
|
|
11865
|
+
405: {
|
|
11866
|
+
content: {
|
|
11867
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11868
|
+
};
|
|
11869
|
+
};
|
|
11156
11870
|
/** @description Validation Error */
|
|
11157
11871
|
422: {
|
|
11158
11872
|
content: {
|
|
11159
11873
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11160
11874
|
};
|
|
11161
11875
|
};
|
|
11876
|
+
/** @description Bad Gateway */
|
|
11877
|
+
502: {
|
|
11878
|
+
content: {
|
|
11879
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11880
|
+
};
|
|
11881
|
+
};
|
|
11162
11882
|
};
|
|
11163
11883
|
};
|
|
11164
11884
|
/**
|
|
11165
|
-
*
|
|
11166
|
-
* @description Returns a list of
|
|
11885
|
+
* Get accounting categories (PMS)
|
|
11886
|
+
* @description Returns a list of accounting categories. When not available for a specific PMS, it will return the same values as the product categories.
|
|
11167
11887
|
*/
|
|
11168
|
-
|
|
11888
|
+
pms_get_accounting_categories: {
|
|
11169
11889
|
parameters: {
|
|
11170
11890
|
query?: {
|
|
11171
11891
|
page?: number;
|
|
@@ -11179,7 +11899,7 @@ export interface operations {
|
|
|
11179
11899
|
/** @description Successful Response */
|
|
11180
11900
|
200: {
|
|
11181
11901
|
content: {
|
|
11182
|
-
'application/json': components['schemas']['
|
|
11902
|
+
'application/json': components['schemas']['ChiftPage_PMSAccountingCategoryItem_'];
|
|
11183
11903
|
};
|
|
11184
11904
|
};
|
|
11185
11905
|
/** @description Bad Request */
|
|
@@ -11188,41 +11908,45 @@ export interface operations {
|
|
|
11188
11908
|
'application/json': components['schemas']['ChiftError'];
|
|
11189
11909
|
};
|
|
11190
11910
|
};
|
|
11911
|
+
/** @description Method Not Allowed */
|
|
11912
|
+
405: {
|
|
11913
|
+
content: {
|
|
11914
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11915
|
+
};
|
|
11916
|
+
};
|
|
11191
11917
|
/** @description Validation Error */
|
|
11192
11918
|
422: {
|
|
11193
11919
|
content: {
|
|
11194
11920
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11195
11921
|
};
|
|
11196
11922
|
};
|
|
11923
|
+
/** @description Bad Gateway */
|
|
11924
|
+
502: {
|
|
11925
|
+
content: {
|
|
11926
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11927
|
+
};
|
|
11928
|
+
};
|
|
11197
11929
|
};
|
|
11198
11930
|
};
|
|
11199
11931
|
/**
|
|
11200
|
-
*
|
|
11201
|
-
* @description Returns
|
|
11932
|
+
* Get closure info for a specific day (PMS)
|
|
11933
|
+
* @description Returns whether the closure was already done for a specific day or not
|
|
11202
11934
|
*/
|
|
11203
|
-
|
|
11935
|
+
pms_get_closure: {
|
|
11204
11936
|
parameters: {
|
|
11205
11937
|
query?: {
|
|
11206
|
-
|
|
11207
|
-
accounting_category?: components['schemas']['TransactionAccountingCategory'];
|
|
11208
|
-
/** @description Get all transactions more recent than this one excluded */
|
|
11209
|
-
starting_from?: string;
|
|
11210
|
-
/** @description Get all transactions for a specific balance */
|
|
11211
|
-
balance_id?: string;
|
|
11212
|
-
date_from?: string;
|
|
11213
|
-
date_to?: string;
|
|
11214
|
-
page?: number;
|
|
11215
|
-
size?: number;
|
|
11938
|
+
location_id?: string;
|
|
11216
11939
|
};
|
|
11217
11940
|
path: {
|
|
11218
11941
|
consumer_id: string;
|
|
11942
|
+
date: string;
|
|
11219
11943
|
};
|
|
11220
11944
|
};
|
|
11221
11945
|
responses: {
|
|
11222
11946
|
/** @description Successful Response */
|
|
11223
11947
|
200: {
|
|
11224
11948
|
content: {
|
|
11225
|
-
'application/json': components['schemas']['
|
|
11949
|
+
'application/json': components['schemas']['PMSClosureItem'];
|
|
11226
11950
|
};
|
|
11227
11951
|
};
|
|
11228
11952
|
/** @description Bad Request */
|
|
@@ -11231,12 +11955,24 @@ export interface operations {
|
|
|
11231
11955
|
'application/json': components['schemas']['ChiftError'];
|
|
11232
11956
|
};
|
|
11233
11957
|
};
|
|
11958
|
+
/** @description Method Not Allowed */
|
|
11959
|
+
405: {
|
|
11960
|
+
content: {
|
|
11961
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11962
|
+
};
|
|
11963
|
+
};
|
|
11234
11964
|
/** @description Validation Error */
|
|
11235
11965
|
422: {
|
|
11236
11966
|
content: {
|
|
11237
11967
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11238
11968
|
};
|
|
11239
11969
|
};
|
|
11970
|
+
/** @description Bad Gateway */
|
|
11971
|
+
502: {
|
|
11972
|
+
content: {
|
|
11973
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11974
|
+
};
|
|
11975
|
+
};
|
|
11240
11976
|
};
|
|
11241
11977
|
};
|
|
11242
11978
|
/**
|