@chift/chift-nodejs 1.0.13 → 1.0.15
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 +7 -1
- package/dist/src/modules/accounting.d.ts +59 -49
- package/dist/src/modules/api.d.ts +1626 -691
- package/dist/src/modules/consumer.d.ts +318 -131
- package/dist/src/modules/consumer.js +11 -0
- package/dist/src/modules/consumers.d.ts +1625 -690
- package/dist/src/modules/ecommerce.d.ts +11 -11
- package/dist/src/modules/integrations.d.ts +1 -1
- package/dist/src/modules/internalApi.d.ts +2 -0
- package/dist/src/modules/internalApi.js +6 -0
- package/dist/src/modules/invoicing.d.ts +6 -4
- package/dist/src/modules/pms.d.ts +15 -0
- package/dist/src/modules/pms.js +47 -0
- package/dist/src/modules/pos.d.ts +18 -18
- package/dist/src/modules/sync.d.ts +1299 -551
- package/dist/src/types/api.d.ts +1 -0
- package/dist/src/types/public-api/schema.d.ts +1870 -1178
- package/package.json +1 -1
- package/src/modules/consumer.ts +3 -0
- package/src/modules/pms.ts +67 -0
- package/src/modules/pos.ts +4 -4
- package/src/types/public-api/schema.d.ts +12029 -0
- package/src/types/public-api/schema.ts +987 -288
- 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
|
|
@@ -1126,7 +1172,8 @@ export interface components {
|
|
|
1126
1172
|
| 'Communication'
|
|
1127
1173
|
| 'Banking'
|
|
1128
1174
|
| 'Custom'
|
|
1129
|
-
| 'Payment'
|
|
1175
|
+
| 'Payment'
|
|
1176
|
+
| 'Property Management System';
|
|
1130
1177
|
/** AttachmentItem */
|
|
1131
1178
|
AttachmentItem: {
|
|
1132
1179
|
/** Base64 String */
|
|
@@ -1268,6 +1315,23 @@ export interface components {
|
|
|
1268
1315
|
*/
|
|
1269
1316
|
execution_date: string;
|
|
1270
1317
|
};
|
|
1318
|
+
/** BookYear */
|
|
1319
|
+
BookYear: {
|
|
1320
|
+
/** Name */
|
|
1321
|
+
name: string;
|
|
1322
|
+
/**
|
|
1323
|
+
* Start
|
|
1324
|
+
* Format: date
|
|
1325
|
+
*/
|
|
1326
|
+
start: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* End
|
|
1329
|
+
* Format: date
|
|
1330
|
+
*/
|
|
1331
|
+
end: string;
|
|
1332
|
+
/** Closed */
|
|
1333
|
+
closed: boolean;
|
|
1334
|
+
};
|
|
1271
1335
|
/**
|
|
1272
1336
|
* BoolParam
|
|
1273
1337
|
* @description An enumeration.
|
|
@@ -1414,6 +1478,17 @@ export interface components {
|
|
|
1414
1478
|
/** Size */
|
|
1415
1479
|
size: number;
|
|
1416
1480
|
};
|
|
1481
|
+
/** ChiftPage[BookYear] */
|
|
1482
|
+
ChiftPage_BookYear_: {
|
|
1483
|
+
/** Items */
|
|
1484
|
+
items: components['schemas']['BookYear'][];
|
|
1485
|
+
/** Total */
|
|
1486
|
+
total: number;
|
|
1487
|
+
/** Page */
|
|
1488
|
+
page: number;
|
|
1489
|
+
/** Size */
|
|
1490
|
+
size: number;
|
|
1491
|
+
};
|
|
1417
1492
|
/** ChiftPage[CategoryItem] */
|
|
1418
1493
|
ChiftPage_CategoryItem_: {
|
|
1419
1494
|
/** Items */
|
|
@@ -1590,10 +1665,21 @@ export interface components {
|
|
|
1590
1665
|
/** Size */
|
|
1591
1666
|
size: number;
|
|
1592
1667
|
};
|
|
1593
|
-
/** ChiftPage[
|
|
1594
|
-
|
|
1668
|
+
/** ChiftPage[OutstandingItem] */
|
|
1669
|
+
ChiftPage_OutstandingItem_: {
|
|
1670
|
+
/** Items */
|
|
1671
|
+
items: components['schemas']['OutstandingItem'][];
|
|
1672
|
+
/** Total */
|
|
1673
|
+
total: number;
|
|
1674
|
+
/** Page */
|
|
1675
|
+
page: number;
|
|
1676
|
+
/** Size */
|
|
1677
|
+
size: number;
|
|
1678
|
+
};
|
|
1679
|
+
/** ChiftPage[PMSAccountingCategoryItem] */
|
|
1680
|
+
ChiftPage_PMSAccountingCategoryItem_: {
|
|
1595
1681
|
/** Items */
|
|
1596
|
-
items: components['schemas']['
|
|
1682
|
+
items: components['schemas']['PMSAccountingCategoryItem'][];
|
|
1597
1683
|
/** Total */
|
|
1598
1684
|
total: number;
|
|
1599
1685
|
/** Page */
|
|
@@ -1601,10 +1687,43 @@ export interface components {
|
|
|
1601
1687
|
/** Size */
|
|
1602
1688
|
size: number;
|
|
1603
1689
|
};
|
|
1604
|
-
/** ChiftPage[
|
|
1605
|
-
|
|
1690
|
+
/** ChiftPage[PMSLocationItem] */
|
|
1691
|
+
ChiftPage_PMSLocationItem_: {
|
|
1606
1692
|
/** Items */
|
|
1607
|
-
items: components['schemas']['
|
|
1693
|
+
items: components['schemas']['PMSLocationItem'][];
|
|
1694
|
+
/** Total */
|
|
1695
|
+
total: number;
|
|
1696
|
+
/** Page */
|
|
1697
|
+
page: number;
|
|
1698
|
+
/** Size */
|
|
1699
|
+
size: number;
|
|
1700
|
+
};
|
|
1701
|
+
/** ChiftPage[PMSOrderItem] */
|
|
1702
|
+
ChiftPage_PMSOrderItem_: {
|
|
1703
|
+
/** Items */
|
|
1704
|
+
items: components['schemas']['PMSOrderItem'][];
|
|
1705
|
+
/** Total */
|
|
1706
|
+
total: number;
|
|
1707
|
+
/** Page */
|
|
1708
|
+
page: number;
|
|
1709
|
+
/** Size */
|
|
1710
|
+
size: number;
|
|
1711
|
+
};
|
|
1712
|
+
/** ChiftPage[PMSPaymentItem] */
|
|
1713
|
+
ChiftPage_PMSPaymentItem_: {
|
|
1714
|
+
/** Items */
|
|
1715
|
+
items: components['schemas']['PMSPaymentItem'][];
|
|
1716
|
+
/** Total */
|
|
1717
|
+
total: number;
|
|
1718
|
+
/** Page */
|
|
1719
|
+
page: number;
|
|
1720
|
+
/** Size */
|
|
1721
|
+
size: number;
|
|
1722
|
+
};
|
|
1723
|
+
/** ChiftPage[PMSPaymentMethods] */
|
|
1724
|
+
ChiftPage_PMSPaymentMethods_: {
|
|
1725
|
+
/** Items */
|
|
1726
|
+
items: components['schemas']['PMSPaymentMethods'][];
|
|
1608
1727
|
/** Total */
|
|
1609
1728
|
total: number;
|
|
1610
1729
|
/** Page */
|
|
@@ -1634,10 +1753,21 @@ export interface components {
|
|
|
1634
1753
|
/** Size */
|
|
1635
1754
|
size: number;
|
|
1636
1755
|
};
|
|
1637
|
-
/** ChiftPage[
|
|
1638
|
-
|
|
1756
|
+
/** ChiftPage[POSOrderItem] */
|
|
1757
|
+
ChiftPage_POSOrderItem_: {
|
|
1639
1758
|
/** Items */
|
|
1640
|
-
items: components['schemas']['
|
|
1759
|
+
items: components['schemas']['POSOrderItem'][];
|
|
1760
|
+
/** Total */
|
|
1761
|
+
total: number;
|
|
1762
|
+
/** Page */
|
|
1763
|
+
page: number;
|
|
1764
|
+
/** Size */
|
|
1765
|
+
size: number;
|
|
1766
|
+
};
|
|
1767
|
+
/** ChiftPage[POSPaymentItem] */
|
|
1768
|
+
ChiftPage_POSPaymentItem_: {
|
|
1769
|
+
/** Items */
|
|
1770
|
+
items: components['schemas']['POSPaymentItem'][];
|
|
1641
1771
|
/** Total */
|
|
1642
1772
|
total: number;
|
|
1643
1773
|
/** Page */
|
|
@@ -1645,10 +1775,10 @@ export interface components {
|
|
|
1645
1775
|
/** Size */
|
|
1646
1776
|
size: number;
|
|
1647
1777
|
};
|
|
1648
|
-
/** ChiftPage[
|
|
1649
|
-
|
|
1778
|
+
/** ChiftPage[POSProductItem] */
|
|
1779
|
+
ChiftPage_POSProductItem_: {
|
|
1650
1780
|
/** Items */
|
|
1651
|
-
items: components['schemas']['
|
|
1781
|
+
items: components['schemas']['POSProductItem'][];
|
|
1652
1782
|
/** Total */
|
|
1653
1783
|
total: number;
|
|
1654
1784
|
/** Page */
|
|
@@ -2903,6 +3033,10 @@ export interface components {
|
|
|
2903
3033
|
* @default true
|
|
2904
3034
|
*/
|
|
2905
3035
|
selected?: boolean;
|
|
3036
|
+
/** Vat */
|
|
3037
|
+
vat?: string;
|
|
3038
|
+
/** Company Number */
|
|
3039
|
+
company_number?: string;
|
|
2906
3040
|
};
|
|
2907
3041
|
/** GenericJournalEntry */
|
|
2908
3042
|
GenericJournalEntry: {
|
|
@@ -3195,6 +3329,8 @@ export interface components {
|
|
|
3195
3329
|
*/
|
|
3196
3330
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3197
3331
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3332
|
+
/** Shipping Country */
|
|
3333
|
+
shipping_country?: string;
|
|
3198
3334
|
/** Lines */
|
|
3199
3335
|
lines: components['schemas']['InvoiceLineItemInMonoAnalyticPlan'][];
|
|
3200
3336
|
};
|
|
@@ -3259,6 +3395,8 @@ export interface components {
|
|
|
3259
3395
|
*/
|
|
3260
3396
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3261
3397
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3398
|
+
/** Shipping Country */
|
|
3399
|
+
shipping_country?: string;
|
|
3262
3400
|
/** Lines */
|
|
3263
3401
|
lines: components['schemas']['InvoiceLineItemInMultiAnalyticPlans'][];
|
|
3264
3402
|
};
|
|
@@ -3843,38 +3981,6 @@ export interface components {
|
|
|
3843
3981
|
| 'supplier_invoice'
|
|
3844
3982
|
| 'supplier_refund'
|
|
3845
3983
|
| '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
3984
|
/** Journal */
|
|
3879
3985
|
Journal: {
|
|
3880
3986
|
/** Id */
|
|
@@ -4367,63 +4473,6 @@ export interface components {
|
|
|
4367
4473
|
*/
|
|
4368
4474
|
id: string;
|
|
4369
4475
|
};
|
|
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
4476
|
/** OrderItemIn */
|
|
4428
4477
|
OrderItemIn: {
|
|
4429
4478
|
customer: components['schemas']['OrderCustomerItem'];
|
|
@@ -4476,6 +4525,11 @@ export interface components {
|
|
|
4476
4525
|
* Format: date-time
|
|
4477
4526
|
*/
|
|
4478
4527
|
confirmed_on?: string;
|
|
4528
|
+
/**
|
|
4529
|
+
* Delivery Date
|
|
4530
|
+
* Format: date-time
|
|
4531
|
+
*/
|
|
4532
|
+
delivery_date?: string;
|
|
4479
4533
|
/**
|
|
4480
4534
|
* Cancelled On
|
|
4481
4535
|
* Format: date-time
|
|
@@ -4649,6 +4703,11 @@ export interface components {
|
|
|
4649
4703
|
sku?: string;
|
|
4650
4704
|
/** Name */
|
|
4651
4705
|
name: string;
|
|
4706
|
+
/**
|
|
4707
|
+
* Categories
|
|
4708
|
+
* @default []
|
|
4709
|
+
*/
|
|
4710
|
+
categories?: components['schemas']['app__routers__commerce__ProductCategoryItem'][];
|
|
4652
4711
|
};
|
|
4653
4712
|
/** OrderPaymentMethods */
|
|
4654
4713
|
OrderPaymentMethods: {
|
|
@@ -4699,13 +4758,24 @@ export interface components {
|
|
|
4699
4758
|
* @default []
|
|
4700
4759
|
*/
|
|
4701
4760
|
shipping_refunds?: components['schemas']['ShippingRefund'][];
|
|
4761
|
+
/**
|
|
4762
|
+
* Transactions
|
|
4763
|
+
* @default []
|
|
4764
|
+
*/
|
|
4765
|
+
transactions?: components['schemas']['OrderTransactions'][];
|
|
4702
4766
|
};
|
|
4703
4767
|
/**
|
|
4704
4768
|
* OrderStatus
|
|
4705
4769
|
* @description An enumeration.
|
|
4706
4770
|
* @enum {string}
|
|
4707
4771
|
*/
|
|
4708
|
-
OrderStatus:
|
|
4772
|
+
OrderStatus:
|
|
4773
|
+
| 'cancelled_unpaid'
|
|
4774
|
+
| 'cancelled'
|
|
4775
|
+
| 'draft'
|
|
4776
|
+
| 'confirmed'
|
|
4777
|
+
| 'shipped'
|
|
4778
|
+
| 'refunded';
|
|
4709
4779
|
/** OrderTransactions */
|
|
4710
4780
|
OrderTransactions: {
|
|
4711
4781
|
/**
|
|
@@ -4771,63 +4841,388 @@ export interface components {
|
|
|
4771
4841
|
* @enum {string}
|
|
4772
4842
|
*/
|
|
4773
4843
|
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: {
|
|
4844
|
+
/** PMSAccountingCategoryItem */
|
|
4845
|
+
PMSAccountingCategoryItem: {
|
|
4788
4846
|
/** Id */
|
|
4789
4847
|
id: string;
|
|
4790
|
-
/**
|
|
4791
|
-
|
|
4792
|
-
|
|
4793
|
-
|
|
4848
|
+
/**
|
|
4849
|
+
* Source Ref
|
|
4850
|
+
* @description Technical id in the target software
|
|
4851
|
+
*/
|
|
4852
|
+
source_ref: components['schemas']['Ref'];
|
|
4794
4853
|
/** Name */
|
|
4795
4854
|
name: string;
|
|
4796
|
-
/** Phone */
|
|
4797
|
-
phone?: string;
|
|
4798
|
-
/** Email */
|
|
4799
|
-
email?: string;
|
|
4800
4855
|
/**
|
|
4801
|
-
*
|
|
4802
|
-
*
|
|
4856
|
+
* Id Parent
|
|
4857
|
+
* @description Indicates if the category belongs to a parent category
|
|
4803
4858
|
*/
|
|
4804
|
-
|
|
4805
|
-
/** Addresses */
|
|
4806
|
-
addresses?: components['schemas']['AddressItem'][];
|
|
4807
|
-
/** Loyalty */
|
|
4808
|
-
loyalty?: number;
|
|
4859
|
+
id_parent?: string;
|
|
4809
4860
|
/**
|
|
4810
|
-
*
|
|
4811
|
-
*
|
|
4812
|
-
* @description Birthdate
|
|
4861
|
+
* Code
|
|
4862
|
+
* @description Code assigned to the category
|
|
4813
4863
|
*/
|
|
4814
|
-
|
|
4815
|
-
};
|
|
4816
|
-
/** POSLocationItem */
|
|
4817
|
-
POSLocationItem: {
|
|
4818
|
-
/** Id */
|
|
4819
|
-
id: string;
|
|
4820
|
-
/** Name */
|
|
4821
|
-
name: string;
|
|
4864
|
+
code?: string;
|
|
4822
4865
|
/**
|
|
4823
|
-
*
|
|
4824
|
-
* @description
|
|
4866
|
+
* Ledger Account Code
|
|
4867
|
+
* @description Ledger account code assigned to the category
|
|
4825
4868
|
*/
|
|
4826
|
-
|
|
4827
|
-
|
|
4828
|
-
|
|
4829
|
-
|
|
4830
|
-
|
|
4869
|
+
ledger_account_code?: string;
|
|
4870
|
+
/**
|
|
4871
|
+
* Posting Account Code
|
|
4872
|
+
* @description Posting account code assigned to the category
|
|
4873
|
+
*/
|
|
4874
|
+
posting_account_code?: string;
|
|
4875
|
+
};
|
|
4876
|
+
/** PMSClosureItem */
|
|
4877
|
+
PMSClosureItem: {
|
|
4878
|
+
/**
|
|
4879
|
+
* Date
|
|
4880
|
+
* Format: date
|
|
4881
|
+
*/
|
|
4882
|
+
date: string;
|
|
4883
|
+
status: components['schemas']['ClosureStates'];
|
|
4884
|
+
};
|
|
4885
|
+
/** PMSLocationItem */
|
|
4886
|
+
PMSLocationItem: {
|
|
4887
|
+
/** Id */
|
|
4888
|
+
id: string;
|
|
4889
|
+
/** Name */
|
|
4890
|
+
name: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Timezone
|
|
4893
|
+
* @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
|
|
4894
|
+
*/
|
|
4895
|
+
timezone?: string;
|
|
4896
|
+
address?: components['schemas']['AddressItem'];
|
|
4897
|
+
};
|
|
4898
|
+
/** PMSOrderItem */
|
|
4899
|
+
PMSOrderItem: {
|
|
4900
|
+
/** Id */
|
|
4901
|
+
id: string;
|
|
4902
|
+
/**
|
|
4903
|
+
* Source Ref
|
|
4904
|
+
* @description Technical id in the target software
|
|
4905
|
+
*/
|
|
4906
|
+
source_ref: components['schemas']['Ref'];
|
|
4907
|
+
/** Order Number */
|
|
4908
|
+
order_number?: string;
|
|
4909
|
+
/**
|
|
4910
|
+
* Creation Date
|
|
4911
|
+
* Format: date-time
|
|
4912
|
+
*/
|
|
4913
|
+
creation_date: string;
|
|
4914
|
+
/**
|
|
4915
|
+
* Closing Date
|
|
4916
|
+
* Format: date-time
|
|
4917
|
+
*/
|
|
4918
|
+
closing_date?: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* Service Date
|
|
4921
|
+
* Format: date-time
|
|
4922
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
4923
|
+
*/
|
|
4924
|
+
service_date?: string;
|
|
4925
|
+
/**
|
|
4926
|
+
* Device Id
|
|
4927
|
+
* @description ID of device that created the order
|
|
4928
|
+
*/
|
|
4929
|
+
device_id?: string;
|
|
4930
|
+
/** Total */
|
|
4931
|
+
total: number;
|
|
4932
|
+
/** Tax Amount */
|
|
4933
|
+
tax_amount: number;
|
|
4934
|
+
/** Total Discount */
|
|
4935
|
+
total_discount?: number;
|
|
4936
|
+
/** Total Refund */
|
|
4937
|
+
total_refund?: number;
|
|
4938
|
+
/**
|
|
4939
|
+
* Total Tip
|
|
4940
|
+
* @default 0
|
|
4941
|
+
*/
|
|
4942
|
+
total_tip?: number;
|
|
4943
|
+
/** Currency */
|
|
4944
|
+
currency?: string;
|
|
4945
|
+
/** Country */
|
|
4946
|
+
country?: string;
|
|
4947
|
+
/** Loyalty */
|
|
4948
|
+
loyalty?: number;
|
|
4949
|
+
/** Customer Id */
|
|
4950
|
+
customer_id?: string;
|
|
4951
|
+
/** Location Id */
|
|
4952
|
+
location_id?: string;
|
|
4953
|
+
/** Taxes */
|
|
4954
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4955
|
+
/** Items */
|
|
4956
|
+
items: components['schemas']['PMSOrderLineItem'][];
|
|
4957
|
+
/**
|
|
4958
|
+
* Service Id
|
|
4959
|
+
* @description Reference to the service related to this order
|
|
4960
|
+
*/
|
|
4961
|
+
service_id?: string;
|
|
4962
|
+
};
|
|
4963
|
+
/** PMSOrderLineItem */
|
|
4964
|
+
PMSOrderLineItem: {
|
|
4965
|
+
/** Id */
|
|
4966
|
+
id: string;
|
|
4967
|
+
/**
|
|
4968
|
+
* Source Ref
|
|
4969
|
+
* @description Technical id in the target software
|
|
4970
|
+
*/
|
|
4971
|
+
source_ref: components['schemas']['Ref'];
|
|
4972
|
+
/** Quantity */
|
|
4973
|
+
quantity: number;
|
|
4974
|
+
/** Unit Price */
|
|
4975
|
+
unit_price: number;
|
|
4976
|
+
/** Total */
|
|
4977
|
+
total: number;
|
|
4978
|
+
/** Tax Amount */
|
|
4979
|
+
tax_amount: number;
|
|
4980
|
+
/** Tax Rate */
|
|
4981
|
+
tax_rate?: number;
|
|
4982
|
+
/** Description */
|
|
4983
|
+
description?: string;
|
|
4984
|
+
/**
|
|
4985
|
+
* Discounts
|
|
4986
|
+
* @default []
|
|
4987
|
+
*/
|
|
4988
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
4989
|
+
/**
|
|
4990
|
+
* Product Id
|
|
4991
|
+
* @description Reference to the product related to this item
|
|
4992
|
+
*/
|
|
4993
|
+
product_id?: string;
|
|
4994
|
+
/**
|
|
4995
|
+
* Accounting Category Id
|
|
4996
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
4997
|
+
*/
|
|
4998
|
+
accounting_category_id?: string;
|
|
4999
|
+
};
|
|
5000
|
+
/** PMSPaymentItem */
|
|
5001
|
+
PMSPaymentItem: {
|
|
5002
|
+
/** Id */
|
|
5003
|
+
id?: string;
|
|
5004
|
+
/**
|
|
5005
|
+
* Source Ref
|
|
5006
|
+
* @description Technical id in the target software
|
|
5007
|
+
*/
|
|
5008
|
+
source_ref: components['schemas']['Ref'];
|
|
5009
|
+
/** Payment Method Id */
|
|
5010
|
+
payment_method_id?: string;
|
|
5011
|
+
/** Payment Method Name */
|
|
5012
|
+
payment_method_name?: string;
|
|
5013
|
+
/** Total */
|
|
5014
|
+
total: number;
|
|
5015
|
+
/**
|
|
5016
|
+
* Tip
|
|
5017
|
+
* @default 0
|
|
5018
|
+
*/
|
|
5019
|
+
tip?: number;
|
|
5020
|
+
/** @default Unknown */
|
|
5021
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5022
|
+
/** Currency */
|
|
5023
|
+
currency?: string;
|
|
5024
|
+
/**
|
|
5025
|
+
* Date
|
|
5026
|
+
* Format: date-time
|
|
5027
|
+
*/
|
|
5028
|
+
date?: string;
|
|
5029
|
+
};
|
|
5030
|
+
/** PMSPaymentMethods */
|
|
5031
|
+
PMSPaymentMethods: {
|
|
5032
|
+
/** Id */
|
|
5033
|
+
id: string;
|
|
5034
|
+
/**
|
|
5035
|
+
* Source Ref
|
|
5036
|
+
* @description Technical id in the target software
|
|
5037
|
+
*/
|
|
5038
|
+
source_ref: components['schemas']['Ref'];
|
|
5039
|
+
/** Name */
|
|
5040
|
+
name: string;
|
|
5041
|
+
/** Extra */
|
|
5042
|
+
extra?: string;
|
|
5043
|
+
/**
|
|
5044
|
+
* Ledger Account Code
|
|
5045
|
+
* @description Ledger account code assigned to the category
|
|
5046
|
+
*/
|
|
5047
|
+
ledger_account_code?: string;
|
|
5048
|
+
};
|
|
5049
|
+
/**
|
|
5050
|
+
* PMSStates
|
|
5051
|
+
* @description An enumeration.
|
|
5052
|
+
* @enum {unknown}
|
|
5053
|
+
*/
|
|
5054
|
+
PMSStates: 'consumed' | 'closed';
|
|
5055
|
+
/** POSCreateCustomerItem */
|
|
5056
|
+
POSCreateCustomerItem: {
|
|
5057
|
+
/** First Name */
|
|
5058
|
+
first_name: string;
|
|
5059
|
+
/** Last Name */
|
|
5060
|
+
last_name: string;
|
|
5061
|
+
/** Phone */
|
|
5062
|
+
phone?: string;
|
|
5063
|
+
/** Email */
|
|
5064
|
+
email?: string;
|
|
5065
|
+
address?: components['schemas']['PostAddressItem'];
|
|
5066
|
+
};
|
|
5067
|
+
/** POSCustomerItem */
|
|
5068
|
+
POSCustomerItem: {
|
|
5069
|
+
/** Id */
|
|
5070
|
+
id: string;
|
|
5071
|
+
/** First Name */
|
|
5072
|
+
first_name?: string;
|
|
5073
|
+
/** Last Name */
|
|
5074
|
+
last_name?: string;
|
|
5075
|
+
/** Name */
|
|
5076
|
+
name: string;
|
|
5077
|
+
/** Phone */
|
|
5078
|
+
phone?: string;
|
|
5079
|
+
/** Email */
|
|
5080
|
+
email?: string;
|
|
5081
|
+
/**
|
|
5082
|
+
* Created On
|
|
5083
|
+
* Format: date-time
|
|
5084
|
+
*/
|
|
5085
|
+
created_on?: string;
|
|
5086
|
+
/** Addresses */
|
|
5087
|
+
addresses?: components['schemas']['AddressItem'][];
|
|
5088
|
+
/** Loyalty */
|
|
5089
|
+
loyalty?: number;
|
|
5090
|
+
/**
|
|
5091
|
+
* Birthdate
|
|
5092
|
+
* Format: date
|
|
5093
|
+
* @description Birthdate
|
|
5094
|
+
*/
|
|
5095
|
+
birthdate?: string;
|
|
5096
|
+
};
|
|
5097
|
+
/** POSItem */
|
|
5098
|
+
POSItem: {
|
|
5099
|
+
/** Id */
|
|
5100
|
+
id: string;
|
|
5101
|
+
/** Quantity */
|
|
5102
|
+
quantity: number;
|
|
5103
|
+
/** Unit Price */
|
|
5104
|
+
unit_price: number;
|
|
5105
|
+
/** Total */
|
|
5106
|
+
total: number;
|
|
5107
|
+
/** Tax Amount */
|
|
5108
|
+
tax_amount: number;
|
|
5109
|
+
/** Tax Rate */
|
|
5110
|
+
tax_rate?: number;
|
|
5111
|
+
/** Description */
|
|
5112
|
+
description?: string;
|
|
5113
|
+
/**
|
|
5114
|
+
* Discounts
|
|
5115
|
+
* @default []
|
|
5116
|
+
*/
|
|
5117
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
5118
|
+
/**
|
|
5119
|
+
* Product Id
|
|
5120
|
+
* @description Reference to the product related to this item
|
|
5121
|
+
*/
|
|
5122
|
+
product_id?: string;
|
|
5123
|
+
/**
|
|
5124
|
+
* Accounting Category Id
|
|
5125
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
5126
|
+
*/
|
|
5127
|
+
accounting_category_id?: string;
|
|
5128
|
+
};
|
|
5129
|
+
/** POSLocationItem */
|
|
5130
|
+
POSLocationItem: {
|
|
5131
|
+
/** Id */
|
|
5132
|
+
id: string;
|
|
5133
|
+
/** Name */
|
|
5134
|
+
name: string;
|
|
5135
|
+
/**
|
|
5136
|
+
* Timezone
|
|
5137
|
+
* @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
|
|
5138
|
+
*/
|
|
5139
|
+
timezone?: string;
|
|
5140
|
+
address?: components['schemas']['AddressItem'];
|
|
5141
|
+
};
|
|
5142
|
+
/** POSOrderItem */
|
|
5143
|
+
POSOrderItem: {
|
|
5144
|
+
/** Id */
|
|
5145
|
+
id: string;
|
|
5146
|
+
/** Order Number */
|
|
5147
|
+
order_number?: string;
|
|
5148
|
+
/**
|
|
5149
|
+
* Creation Date
|
|
5150
|
+
* Format: date-time
|
|
5151
|
+
*/
|
|
5152
|
+
creation_date: string;
|
|
5153
|
+
/**
|
|
5154
|
+
* Closing Date
|
|
5155
|
+
* Format: date-time
|
|
5156
|
+
*/
|
|
5157
|
+
closing_date?: string;
|
|
5158
|
+
/**
|
|
5159
|
+
* Service Date
|
|
5160
|
+
* Format: date-time
|
|
5161
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
5162
|
+
*/
|
|
5163
|
+
service_date?: string;
|
|
5164
|
+
/**
|
|
5165
|
+
* Device Id
|
|
5166
|
+
* @description ID of device that created the order
|
|
5167
|
+
*/
|
|
5168
|
+
device_id?: string;
|
|
5169
|
+
/** Total */
|
|
5170
|
+
total: number;
|
|
5171
|
+
/** Tax Amount */
|
|
5172
|
+
tax_amount: number;
|
|
5173
|
+
/** Total Discount */
|
|
5174
|
+
total_discount?: number;
|
|
5175
|
+
/** Total Refund */
|
|
5176
|
+
total_refund?: number;
|
|
5177
|
+
/**
|
|
5178
|
+
* Total Tip
|
|
5179
|
+
* @default 0
|
|
5180
|
+
*/
|
|
5181
|
+
total_tip?: number;
|
|
5182
|
+
/** Currency */
|
|
5183
|
+
currency?: string;
|
|
5184
|
+
/** Country */
|
|
5185
|
+
country?: string;
|
|
5186
|
+
/** Loyalty */
|
|
5187
|
+
loyalty?: number;
|
|
5188
|
+
/** Customer Id */
|
|
5189
|
+
customer_id?: string;
|
|
5190
|
+
/** Location Id */
|
|
5191
|
+
location_id?: string;
|
|
5192
|
+
/** Taxes */
|
|
5193
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
5194
|
+
/** Payments */
|
|
5195
|
+
payments: components['schemas']['POSPaymentItem'][];
|
|
5196
|
+
/** Items */
|
|
5197
|
+
items: components['schemas']['POSItem'][];
|
|
5198
|
+
};
|
|
5199
|
+
/** POSPaymentItem */
|
|
5200
|
+
POSPaymentItem: {
|
|
5201
|
+
/** Id */
|
|
5202
|
+
id?: string;
|
|
5203
|
+
/** Payment Method Id */
|
|
5204
|
+
payment_method_id?: string;
|
|
5205
|
+
/** Payment Method Name */
|
|
5206
|
+
payment_method_name?: string;
|
|
5207
|
+
/** Total */
|
|
5208
|
+
total: number;
|
|
5209
|
+
/**
|
|
5210
|
+
* Tip
|
|
5211
|
+
* @default 0
|
|
5212
|
+
*/
|
|
5213
|
+
tip?: number;
|
|
5214
|
+
/** @default Unknown */
|
|
5215
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5216
|
+
/** Currency */
|
|
5217
|
+
currency?: string;
|
|
5218
|
+
/**
|
|
5219
|
+
* Date
|
|
5220
|
+
* Format: date-time
|
|
5221
|
+
*/
|
|
5222
|
+
date?: string;
|
|
5223
|
+
};
|
|
5224
|
+
/** POSProductItem */
|
|
5225
|
+
POSProductItem: {
|
|
4831
5226
|
/** Id */
|
|
4832
5227
|
id: string;
|
|
4833
5228
|
/**
|
|
@@ -4943,36 +5338,11 @@ export interface components {
|
|
|
4943
5338
|
* Reconciled
|
|
4944
5339
|
* @default false
|
|
4945
5340
|
*/
|
|
4946
|
-
reconciled?: boolean;
|
|
4947
|
-
/** Communication */
|
|
4948
|
-
communication?: string;
|
|
4949
|
-
/** Matching Number */
|
|
4950
|
-
matching_number?: string;
|
|
4951
|
-
};
|
|
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;
|
|
5341
|
+
reconciled?: boolean;
|
|
5342
|
+
/** Communication */
|
|
5343
|
+
communication?: string;
|
|
5344
|
+
/** Matching Number */
|
|
5345
|
+
matching_number?: string;
|
|
4976
5346
|
};
|
|
4977
5347
|
/** PaymentMethodItem */
|
|
4978
5348
|
PaymentMethodItem: {
|
|
@@ -6259,25 +6629,6 @@ export interface components {
|
|
|
6259
6629
|
/** Size */
|
|
6260
6630
|
size: number;
|
|
6261
6631
|
};
|
|
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
6632
|
/** ProductCategoryItem */
|
|
6282
6633
|
app__routers__pos__ProductCategoryItem: {
|
|
6283
6634
|
/** Id */
|
|
@@ -6482,6 +6833,25 @@ export interface components {
|
|
|
6482
6833
|
* @enum {string}
|
|
6483
6834
|
*/
|
|
6484
6835
|
models__invoicing__VatCodeType: 'sale' | 'purchase' | 'both' | 'unknown';
|
|
6836
|
+
/** DiscountItem */
|
|
6837
|
+
models__pos_pms__DiscountItem: {
|
|
6838
|
+
/** Name */
|
|
6839
|
+
name?: string;
|
|
6840
|
+
/** Total */
|
|
6841
|
+
total: number;
|
|
6842
|
+
};
|
|
6843
|
+
/**
|
|
6844
|
+
* PaymentStatus
|
|
6845
|
+
* @description An enumeration.
|
|
6846
|
+
* @enum {unknown}
|
|
6847
|
+
*/
|
|
6848
|
+
models__pos_pms__PaymentStatus:
|
|
6849
|
+
| 'Pending'
|
|
6850
|
+
| 'Completed'
|
|
6851
|
+
| 'Canceled'
|
|
6852
|
+
| 'Failed'
|
|
6853
|
+
| 'Unknown'
|
|
6854
|
+
| 'Authorised';
|
|
6485
6855
|
};
|
|
6486
6856
|
responses: never;
|
|
6487
6857
|
parameters: never;
|
|
@@ -7583,6 +7953,40 @@ export interface operations {
|
|
|
7583
7953
|
};
|
|
7584
7954
|
};
|
|
7585
7955
|
};
|
|
7956
|
+
/** Get Bookyears */
|
|
7957
|
+
accounting_get_bookyears: {
|
|
7958
|
+
parameters: {
|
|
7959
|
+
query?: {
|
|
7960
|
+
/** @description Accounting folder ID, this needs to be passed when activating the multiple folders feature. */
|
|
7961
|
+
folder_id?: string;
|
|
7962
|
+
page?: number;
|
|
7963
|
+
size?: number;
|
|
7964
|
+
};
|
|
7965
|
+
path: {
|
|
7966
|
+
consumer_id: string;
|
|
7967
|
+
};
|
|
7968
|
+
};
|
|
7969
|
+
responses: {
|
|
7970
|
+
/** @description Successful Response */
|
|
7971
|
+
200: {
|
|
7972
|
+
content: {
|
|
7973
|
+
'application/json': components['schemas']['ChiftPage_BookYear_'];
|
|
7974
|
+
};
|
|
7975
|
+
};
|
|
7976
|
+
/** @description Bad Request */
|
|
7977
|
+
400: {
|
|
7978
|
+
content: {
|
|
7979
|
+
'application/json': components['schemas']['ChiftError'];
|
|
7980
|
+
};
|
|
7981
|
+
};
|
|
7982
|
+
/** @description Validation Error */
|
|
7983
|
+
422: {
|
|
7984
|
+
content: {
|
|
7985
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7986
|
+
};
|
|
7987
|
+
};
|
|
7988
|
+
};
|
|
7989
|
+
};
|
|
7586
7990
|
/** Get Analytic Plans */
|
|
7587
7991
|
accounting_get_analytic_plans: {
|
|
7588
7992
|
parameters: {
|
|
@@ -9409,7 +9813,7 @@ export interface operations {
|
|
|
9409
9813
|
/** @description Successful Response */
|
|
9410
9814
|
200: {
|
|
9411
9815
|
content: {
|
|
9412
|
-
'application/json': components['schemas']['
|
|
9816
|
+
'application/json': components['schemas']['ChiftPage_POSOrderItem_'];
|
|
9413
9817
|
};
|
|
9414
9818
|
};
|
|
9415
9819
|
/** @description Bad Request */
|
|
@@ -9453,7 +9857,7 @@ export interface operations {
|
|
|
9453
9857
|
/** @description Successful Response */
|
|
9454
9858
|
200: {
|
|
9455
9859
|
content: {
|
|
9456
|
-
'application/json': components['schemas']['
|
|
9860
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9457
9861
|
};
|
|
9458
9862
|
};
|
|
9459
9863
|
/** @description Bad Request */
|
|
@@ -9508,7 +9912,7 @@ export interface operations {
|
|
|
9508
9912
|
/** @description Successful Response */
|
|
9509
9913
|
200: {
|
|
9510
9914
|
content: {
|
|
9511
|
-
'application/json': components['schemas']['
|
|
9915
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9512
9916
|
};
|
|
9513
9917
|
};
|
|
9514
9918
|
/** @description Bad Request */
|
|
@@ -9604,7 +10008,7 @@ export interface operations {
|
|
|
9604
10008
|
/** @description Successful Response */
|
|
9605
10009
|
200: {
|
|
9606
10010
|
content: {
|
|
9607
|
-
'application/json': components['schemas']['
|
|
10011
|
+
'application/json': components['schemas']['ChiftPage_POSPaymentItem_'];
|
|
9608
10012
|
};
|
|
9609
10013
|
};
|
|
9610
10014
|
/** @description Bad Request */
|
|
@@ -10348,6 +10752,8 @@ export interface operations {
|
|
|
10348
10752
|
updated_after?: string;
|
|
10349
10753
|
/** @description Include detailed information concerning refunds */
|
|
10350
10754
|
include_detailed_refunds?: components['schemas']['BoolParam'];
|
|
10755
|
+
/** @description Include detailed information about categories */
|
|
10756
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10351
10757
|
page?: number;
|
|
10352
10758
|
size?: number;
|
|
10353
10759
|
};
|
|
@@ -10418,6 +10824,10 @@ export interface operations {
|
|
|
10418
10824
|
*/
|
|
10419
10825
|
ecommerce_get_order: {
|
|
10420
10826
|
parameters: {
|
|
10827
|
+
query?: {
|
|
10828
|
+
/** @description Include detailed information about categories */
|
|
10829
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10830
|
+
};
|
|
10421
10831
|
path: {
|
|
10422
10832
|
order_id: string;
|
|
10423
10833
|
consumer_id: string;
|
|
@@ -10856,13 +11266,197 @@ export interface operations {
|
|
|
10856
11266
|
};
|
|
10857
11267
|
};
|
|
10858
11268
|
/**
|
|
10859
|
-
* Retrieve one product
|
|
10860
|
-
* @description Returns a product
|
|
11269
|
+
* Retrieve one product
|
|
11270
|
+
* @description Returns a product
|
|
11271
|
+
*/
|
|
11272
|
+
invoicing_get_product: {
|
|
11273
|
+
parameters: {
|
|
11274
|
+
path: {
|
|
11275
|
+
product_id: string;
|
|
11276
|
+
consumer_id: string;
|
|
11277
|
+
};
|
|
11278
|
+
};
|
|
11279
|
+
responses: {
|
|
11280
|
+
/** @description Successful Response */
|
|
11281
|
+
200: {
|
|
11282
|
+
content: {
|
|
11283
|
+
'application/json': components['schemas']['ProductItemOut'];
|
|
11284
|
+
};
|
|
11285
|
+
};
|
|
11286
|
+
/** @description Bad Request */
|
|
11287
|
+
400: {
|
|
11288
|
+
content: {
|
|
11289
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11290
|
+
};
|
|
11291
|
+
};
|
|
11292
|
+
/** @description Not Found */
|
|
11293
|
+
404: {
|
|
11294
|
+
content: {
|
|
11295
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11296
|
+
};
|
|
11297
|
+
};
|
|
11298
|
+
/** @description Validation Error */
|
|
11299
|
+
422: {
|
|
11300
|
+
content: {
|
|
11301
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11302
|
+
};
|
|
11303
|
+
};
|
|
11304
|
+
};
|
|
11305
|
+
};
|
|
11306
|
+
/**
|
|
11307
|
+
* Retrieve all opportunities
|
|
11308
|
+
* @description Returns a list of all the opportunities
|
|
11309
|
+
*/
|
|
11310
|
+
invoicing_get_opportunities: {
|
|
11311
|
+
parameters: {
|
|
11312
|
+
query?: {
|
|
11313
|
+
page?: number;
|
|
11314
|
+
size?: number;
|
|
11315
|
+
};
|
|
11316
|
+
path: {
|
|
11317
|
+
consumer_id: string;
|
|
11318
|
+
};
|
|
11319
|
+
};
|
|
11320
|
+
responses: {
|
|
11321
|
+
/** @description Successful Response */
|
|
11322
|
+
200: {
|
|
11323
|
+
content: {
|
|
11324
|
+
'application/json': components['schemas']['ChiftPage_OpportunityItem_'];
|
|
11325
|
+
};
|
|
11326
|
+
};
|
|
11327
|
+
/** @description Bad Request */
|
|
11328
|
+
400: {
|
|
11329
|
+
content: {
|
|
11330
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11331
|
+
};
|
|
11332
|
+
};
|
|
11333
|
+
/** @description Validation Error */
|
|
11334
|
+
422: {
|
|
11335
|
+
content: {
|
|
11336
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11337
|
+
};
|
|
11338
|
+
};
|
|
11339
|
+
};
|
|
11340
|
+
};
|
|
11341
|
+
/**
|
|
11342
|
+
* Retrieve one opportunity
|
|
11343
|
+
* @description Returns an opportunity
|
|
11344
|
+
*/
|
|
11345
|
+
invoicing_get_opportunity: {
|
|
11346
|
+
parameters: {
|
|
11347
|
+
path: {
|
|
11348
|
+
opportunity_id: string;
|
|
11349
|
+
consumer_id: string;
|
|
11350
|
+
};
|
|
11351
|
+
};
|
|
11352
|
+
responses: {
|
|
11353
|
+
/** @description Successful Response */
|
|
11354
|
+
200: {
|
|
11355
|
+
content: {
|
|
11356
|
+
'application/json': components['schemas']['OpportunityItem'];
|
|
11357
|
+
};
|
|
11358
|
+
};
|
|
11359
|
+
/** @description Bad Request */
|
|
11360
|
+
400: {
|
|
11361
|
+
content: {
|
|
11362
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11363
|
+
};
|
|
11364
|
+
};
|
|
11365
|
+
/** @description Not Found */
|
|
11366
|
+
404: {
|
|
11367
|
+
content: {
|
|
11368
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11369
|
+
};
|
|
11370
|
+
};
|
|
11371
|
+
/** @description Validation Error */
|
|
11372
|
+
422: {
|
|
11373
|
+
content: {
|
|
11374
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11375
|
+
};
|
|
11376
|
+
};
|
|
11377
|
+
};
|
|
11378
|
+
};
|
|
11379
|
+
/**
|
|
11380
|
+
* Retrieve all contacts
|
|
11381
|
+
* @description Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.
|
|
11382
|
+
*/
|
|
11383
|
+
invoicing_get_contacts: {
|
|
11384
|
+
parameters: {
|
|
11385
|
+
query?: {
|
|
11386
|
+
/** @description Filter based on the type of the contact (e.g. supplier/customer/prospect). */
|
|
11387
|
+
contact_type?: components['schemas']['ContactType'];
|
|
11388
|
+
page?: number;
|
|
11389
|
+
size?: number;
|
|
11390
|
+
};
|
|
11391
|
+
path: {
|
|
11392
|
+
consumer_id: string;
|
|
11393
|
+
};
|
|
11394
|
+
};
|
|
11395
|
+
responses: {
|
|
11396
|
+
/** @description Successful Response */
|
|
11397
|
+
200: {
|
|
11398
|
+
content: {
|
|
11399
|
+
'application/json': components['schemas']['ChiftPage_ContactItemOut_'];
|
|
11400
|
+
};
|
|
11401
|
+
};
|
|
11402
|
+
/** @description Bad Request */
|
|
11403
|
+
400: {
|
|
11404
|
+
content: {
|
|
11405
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11406
|
+
};
|
|
11407
|
+
};
|
|
11408
|
+
/** @description Validation Error */
|
|
11409
|
+
422: {
|
|
11410
|
+
content: {
|
|
11411
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11412
|
+
};
|
|
11413
|
+
};
|
|
11414
|
+
};
|
|
11415
|
+
};
|
|
11416
|
+
/**
|
|
11417
|
+
* Create a contact
|
|
11418
|
+
* @description Create a new contact.
|
|
11419
|
+
*/
|
|
11420
|
+
invoicing_post_contacts: {
|
|
11421
|
+
parameters: {
|
|
11422
|
+
path: {
|
|
11423
|
+
consumer_id: string;
|
|
11424
|
+
};
|
|
11425
|
+
};
|
|
11426
|
+
requestBody: {
|
|
11427
|
+
content: {
|
|
11428
|
+
'application/json': components['schemas']['ContactItemIn'];
|
|
11429
|
+
};
|
|
11430
|
+
};
|
|
11431
|
+
responses: {
|
|
11432
|
+
/** @description Successful Response */
|
|
11433
|
+
200: {
|
|
11434
|
+
content: {
|
|
11435
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
11436
|
+
};
|
|
11437
|
+
};
|
|
11438
|
+
/** @description Bad Request */
|
|
11439
|
+
400: {
|
|
11440
|
+
content: {
|
|
11441
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11442
|
+
};
|
|
11443
|
+
};
|
|
11444
|
+
/** @description Validation Error */
|
|
11445
|
+
422: {
|
|
11446
|
+
content: {
|
|
11447
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11448
|
+
};
|
|
11449
|
+
};
|
|
11450
|
+
};
|
|
11451
|
+
};
|
|
11452
|
+
/**
|
|
11453
|
+
* Retrieve one contact
|
|
11454
|
+
* @description Returns a contact
|
|
10861
11455
|
*/
|
|
10862
|
-
|
|
11456
|
+
invoicing_get_contact: {
|
|
10863
11457
|
parameters: {
|
|
10864
11458
|
path: {
|
|
10865
|
-
|
|
11459
|
+
contact_id: string;
|
|
10866
11460
|
consumer_id: string;
|
|
10867
11461
|
};
|
|
10868
11462
|
};
|
|
@@ -10870,7 +11464,7 @@ export interface operations {
|
|
|
10870
11464
|
/** @description Successful Response */
|
|
10871
11465
|
200: {
|
|
10872
11466
|
content: {
|
|
10873
|
-
'application/json': components['schemas']['
|
|
11467
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
10874
11468
|
};
|
|
10875
11469
|
};
|
|
10876
11470
|
/** @description Bad Request */
|
|
@@ -10894,10 +11488,10 @@ export interface operations {
|
|
|
10894
11488
|
};
|
|
10895
11489
|
};
|
|
10896
11490
|
/**
|
|
10897
|
-
*
|
|
10898
|
-
* @description Returns
|
|
11491
|
+
* Get list of financial institutions
|
|
11492
|
+
* @description Returns the list of financial institutions the user consent access to
|
|
10899
11493
|
*/
|
|
10900
|
-
|
|
11494
|
+
banking_get_financial_institutions: {
|
|
10901
11495
|
parameters: {
|
|
10902
11496
|
query?: {
|
|
10903
11497
|
page?: number;
|
|
@@ -10911,7 +11505,7 @@ export interface operations {
|
|
|
10911
11505
|
/** @description Successful Response */
|
|
10912
11506
|
200: {
|
|
10913
11507
|
content: {
|
|
10914
|
-
'application/json': components['schemas']['
|
|
11508
|
+
'application/json': components['schemas']['Page_BankingFinancialInstitutionItem_'];
|
|
10915
11509
|
};
|
|
10916
11510
|
};
|
|
10917
11511
|
/** @description Bad Request */
|
|
@@ -10929,13 +11523,16 @@ export interface operations {
|
|
|
10929
11523
|
};
|
|
10930
11524
|
};
|
|
10931
11525
|
/**
|
|
10932
|
-
*
|
|
10933
|
-
* @description Returns
|
|
11526
|
+
* Get list of banking accounts
|
|
11527
|
+
* @description Returns the list of banking accounts
|
|
10934
11528
|
*/
|
|
10935
|
-
|
|
11529
|
+
banking_get_accounts: {
|
|
10936
11530
|
parameters: {
|
|
11531
|
+
query?: {
|
|
11532
|
+
page?: number;
|
|
11533
|
+
size?: number;
|
|
11534
|
+
};
|
|
10937
11535
|
path: {
|
|
10938
|
-
opportunity_id: string;
|
|
10939
11536
|
consumer_id: string;
|
|
10940
11537
|
};
|
|
10941
11538
|
};
|
|
@@ -10943,7 +11540,7 @@ export interface operations {
|
|
|
10943
11540
|
/** @description Successful Response */
|
|
10944
11541
|
200: {
|
|
10945
11542
|
content: {
|
|
10946
|
-
'application/json': components['schemas']['
|
|
11543
|
+
'application/json': components['schemas']['Page_BankingAccountItem_'];
|
|
10947
11544
|
};
|
|
10948
11545
|
};
|
|
10949
11546
|
/** @description Bad Request */
|
|
@@ -10952,12 +11549,6 @@ export interface operations {
|
|
|
10952
11549
|
'application/json': components['schemas']['ChiftError'];
|
|
10953
11550
|
};
|
|
10954
11551
|
};
|
|
10955
|
-
/** @description Not Found */
|
|
10956
|
-
404: {
|
|
10957
|
-
content: {
|
|
10958
|
-
'application/json': components['schemas']['ChiftError'];
|
|
10959
|
-
};
|
|
10960
|
-
};
|
|
10961
11552
|
/** @description Validation Error */
|
|
10962
11553
|
422: {
|
|
10963
11554
|
content: {
|
|
@@ -10967,26 +11558,28 @@ export interface operations {
|
|
|
10967
11558
|
};
|
|
10968
11559
|
};
|
|
10969
11560
|
/**
|
|
10970
|
-
*
|
|
10971
|
-
* @description Returns
|
|
11561
|
+
* Get list of financial transactions
|
|
11562
|
+
* @description Returns the list of transactions of an account
|
|
10972
11563
|
*/
|
|
10973
|
-
|
|
11564
|
+
banking_get_account_transactions: {
|
|
10974
11565
|
parameters: {
|
|
10975
11566
|
query?: {
|
|
10976
|
-
|
|
10977
|
-
|
|
11567
|
+
date_from?: string;
|
|
11568
|
+
date_to?: string;
|
|
11569
|
+
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
10978
11570
|
page?: number;
|
|
10979
11571
|
size?: number;
|
|
10980
11572
|
};
|
|
10981
11573
|
path: {
|
|
10982
11574
|
consumer_id: string;
|
|
11575
|
+
account_id: string;
|
|
10983
11576
|
};
|
|
10984
11577
|
};
|
|
10985
11578
|
responses: {
|
|
10986
11579
|
/** @description Successful Response */
|
|
10987
11580
|
200: {
|
|
10988
11581
|
content: {
|
|
10989
|
-
'application/json': components['schemas']['
|
|
11582
|
+
'application/json': components['schemas']['Page_BankingTransactionItem_'];
|
|
10990
11583
|
};
|
|
10991
11584
|
};
|
|
10992
11585
|
/** @description Bad Request */
|
|
@@ -11004,25 +11597,27 @@ export interface operations {
|
|
|
11004
11597
|
};
|
|
11005
11598
|
};
|
|
11006
11599
|
/**
|
|
11007
|
-
*
|
|
11008
|
-
* @description
|
|
11600
|
+
* Get aggregated list of account counterparts found in transactions
|
|
11601
|
+
* @description Returns the aggregated list of account counterpats found in transactions. Useful for categorisation.
|
|
11009
11602
|
*/
|
|
11010
|
-
|
|
11603
|
+
banking_get_account_counterparts: {
|
|
11011
11604
|
parameters: {
|
|
11605
|
+
query?: {
|
|
11606
|
+
accountid?: string;
|
|
11607
|
+
date_from?: string;
|
|
11608
|
+
date_to?: string;
|
|
11609
|
+
page?: number;
|
|
11610
|
+
size?: number;
|
|
11611
|
+
};
|
|
11012
11612
|
path: {
|
|
11013
11613
|
consumer_id: string;
|
|
11014
11614
|
};
|
|
11015
11615
|
};
|
|
11016
|
-
requestBody: {
|
|
11017
|
-
content: {
|
|
11018
|
-
'application/json': components['schemas']['ContactItemIn'];
|
|
11019
|
-
};
|
|
11020
|
-
};
|
|
11021
11616
|
responses: {
|
|
11022
11617
|
/** @description Successful Response */
|
|
11023
11618
|
200: {
|
|
11024
11619
|
content: {
|
|
11025
|
-
'application/json': components['schemas']['
|
|
11620
|
+
'application/json': components['schemas']['Page_BankingCounterPartItem_'];
|
|
11026
11621
|
};
|
|
11027
11622
|
};
|
|
11028
11623
|
/** @description Bad Request */
|
|
@@ -11040,13 +11635,16 @@ export interface operations {
|
|
|
11040
11635
|
};
|
|
11041
11636
|
};
|
|
11042
11637
|
/**
|
|
11043
|
-
* Retrieve
|
|
11044
|
-
* @description Returns a
|
|
11638
|
+
* Retrieve all Balances
|
|
11639
|
+
* @description Returns a list of balances.
|
|
11045
11640
|
*/
|
|
11046
|
-
|
|
11641
|
+
payment_get_balances: {
|
|
11047
11642
|
parameters: {
|
|
11643
|
+
query?: {
|
|
11644
|
+
page?: number;
|
|
11645
|
+
size?: number;
|
|
11646
|
+
};
|
|
11048
11647
|
path: {
|
|
11049
|
-
contact_id: string;
|
|
11050
11648
|
consumer_id: string;
|
|
11051
11649
|
};
|
|
11052
11650
|
};
|
|
@@ -11054,7 +11652,7 @@ export interface operations {
|
|
|
11054
11652
|
/** @description Successful Response */
|
|
11055
11653
|
200: {
|
|
11056
11654
|
content: {
|
|
11057
|
-
'application/json': components['schemas']['
|
|
11655
|
+
'application/json': components['schemas']['ChiftPage_BalanceItemOut_'];
|
|
11058
11656
|
};
|
|
11059
11657
|
};
|
|
11060
11658
|
/** @description Bad Request */
|
|
@@ -11063,8 +11661,45 @@ export interface operations {
|
|
|
11063
11661
|
'application/json': components['schemas']['ChiftError'];
|
|
11064
11662
|
};
|
|
11065
11663
|
};
|
|
11066
|
-
/** @description
|
|
11067
|
-
|
|
11664
|
+
/** @description Validation Error */
|
|
11665
|
+
422: {
|
|
11666
|
+
content: {
|
|
11667
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11668
|
+
};
|
|
11669
|
+
};
|
|
11670
|
+
};
|
|
11671
|
+
};
|
|
11672
|
+
/**
|
|
11673
|
+
* Retrieve all Transactions
|
|
11674
|
+
* @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
|
|
11675
|
+
*/
|
|
11676
|
+
payment_get_transaction: {
|
|
11677
|
+
parameters: {
|
|
11678
|
+
query?: {
|
|
11679
|
+
/** @description Filter based on the type of the transaction. */
|
|
11680
|
+
accounting_category?: components['schemas']['TransactionAccountingCategory'];
|
|
11681
|
+
/** @description Get all transactions more recent than this one excluded */
|
|
11682
|
+
starting_from?: string;
|
|
11683
|
+
/** @description Get all transactions for a specific balance */
|
|
11684
|
+
balance_id?: string;
|
|
11685
|
+
date_from?: string;
|
|
11686
|
+
date_to?: string;
|
|
11687
|
+
page?: number;
|
|
11688
|
+
size?: number;
|
|
11689
|
+
};
|
|
11690
|
+
path: {
|
|
11691
|
+
consumer_id: string;
|
|
11692
|
+
};
|
|
11693
|
+
};
|
|
11694
|
+
responses: {
|
|
11695
|
+
/** @description Successful Response */
|
|
11696
|
+
200: {
|
|
11697
|
+
content: {
|
|
11698
|
+
'application/json': components['schemas']['ChiftPage_TransactionItemOut_'];
|
|
11699
|
+
};
|
|
11700
|
+
};
|
|
11701
|
+
/** @description Bad Request */
|
|
11702
|
+
400: {
|
|
11068
11703
|
content: {
|
|
11069
11704
|
'application/json': components['schemas']['ChiftError'];
|
|
11070
11705
|
};
|
|
@@ -11078,12 +11713,16 @@ export interface operations {
|
|
|
11078
11713
|
};
|
|
11079
11714
|
};
|
|
11080
11715
|
/**
|
|
11081
|
-
* Get
|
|
11082
|
-
* @description Returns
|
|
11716
|
+
* Get orders (PMS)
|
|
11717
|
+
* @description Returns a list of the orders
|
|
11083
11718
|
*/
|
|
11084
|
-
|
|
11719
|
+
pms_get_orders: {
|
|
11085
11720
|
parameters: {
|
|
11086
|
-
query
|
|
11721
|
+
query: {
|
|
11722
|
+
date_from: string;
|
|
11723
|
+
date_to: string;
|
|
11724
|
+
location_id?: string;
|
|
11725
|
+
state?: components['schemas']['PMSStates'];
|
|
11087
11726
|
page?: number;
|
|
11088
11727
|
size?: number;
|
|
11089
11728
|
};
|
|
@@ -11095,7 +11734,7 @@ export interface operations {
|
|
|
11095
11734
|
/** @description Successful Response */
|
|
11096
11735
|
200: {
|
|
11097
11736
|
content: {
|
|
11098
|
-
'application/json': components['schemas']['
|
|
11737
|
+
'application/json': components['schemas']['ChiftPage_PMSOrderItem_'];
|
|
11099
11738
|
};
|
|
11100
11739
|
};
|
|
11101
11740
|
/** @description Bad Request */
|
|
@@ -11104,19 +11743,31 @@ export interface operations {
|
|
|
11104
11743
|
'application/json': components['schemas']['ChiftError'];
|
|
11105
11744
|
};
|
|
11106
11745
|
};
|
|
11746
|
+
/** @description Method Not Allowed */
|
|
11747
|
+
405: {
|
|
11748
|
+
content: {
|
|
11749
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11750
|
+
};
|
|
11751
|
+
};
|
|
11107
11752
|
/** @description Validation Error */
|
|
11108
11753
|
422: {
|
|
11109
11754
|
content: {
|
|
11110
11755
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11111
11756
|
};
|
|
11112
11757
|
};
|
|
11758
|
+
/** @description Bad Gateway */
|
|
11759
|
+
502: {
|
|
11760
|
+
content: {
|
|
11761
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11762
|
+
};
|
|
11763
|
+
};
|
|
11113
11764
|
};
|
|
11114
11765
|
};
|
|
11115
11766
|
/**
|
|
11116
|
-
* Get
|
|
11117
|
-
* @description Returns
|
|
11767
|
+
* Get locations (PMS)
|
|
11768
|
+
* @description Returns a list of the locations
|
|
11118
11769
|
*/
|
|
11119
|
-
|
|
11770
|
+
pms_get_locations: {
|
|
11120
11771
|
parameters: {
|
|
11121
11772
|
query?: {
|
|
11122
11773
|
page?: number;
|
|
@@ -11130,7 +11781,7 @@ export interface operations {
|
|
|
11130
11781
|
/** @description Successful Response */
|
|
11131
11782
|
200: {
|
|
11132
11783
|
content: {
|
|
11133
|
-
'application/json': components['schemas']['
|
|
11784
|
+
'application/json': components['schemas']['ChiftPage_PMSLocationItem_'];
|
|
11134
11785
|
};
|
|
11135
11786
|
};
|
|
11136
11787
|
/** @description Bad Request */
|
|
@@ -11139,37 +11790,47 @@ export interface operations {
|
|
|
11139
11790
|
'application/json': components['schemas']['ChiftError'];
|
|
11140
11791
|
};
|
|
11141
11792
|
};
|
|
11793
|
+
/** @description Method Not Allowed */
|
|
11794
|
+
405: {
|
|
11795
|
+
content: {
|
|
11796
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11797
|
+
};
|
|
11798
|
+
};
|
|
11142
11799
|
/** @description Validation Error */
|
|
11143
11800
|
422: {
|
|
11144
11801
|
content: {
|
|
11145
11802
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11146
11803
|
};
|
|
11147
11804
|
};
|
|
11805
|
+
/** @description Bad Gateway */
|
|
11806
|
+
502: {
|
|
11807
|
+
content: {
|
|
11808
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11809
|
+
};
|
|
11810
|
+
};
|
|
11148
11811
|
};
|
|
11149
11812
|
};
|
|
11150
11813
|
/**
|
|
11151
|
-
* Get
|
|
11152
|
-
* @description Returns
|
|
11814
|
+
* Get payments (PMS)
|
|
11815
|
+
* @description Returns a list of payments
|
|
11153
11816
|
*/
|
|
11154
|
-
|
|
11817
|
+
pms_get_payments: {
|
|
11155
11818
|
parameters: {
|
|
11156
|
-
query
|
|
11157
|
-
date_from
|
|
11158
|
-
date_to
|
|
11159
|
-
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
11819
|
+
query: {
|
|
11820
|
+
date_from: string;
|
|
11821
|
+
date_to: string;
|
|
11160
11822
|
page?: number;
|
|
11161
11823
|
size?: number;
|
|
11162
11824
|
};
|
|
11163
11825
|
path: {
|
|
11164
11826
|
consumer_id: string;
|
|
11165
|
-
account_id: string;
|
|
11166
11827
|
};
|
|
11167
11828
|
};
|
|
11168
11829
|
responses: {
|
|
11169
11830
|
/** @description Successful Response */
|
|
11170
11831
|
200: {
|
|
11171
11832
|
content: {
|
|
11172
|
-
'application/json': components['schemas']['
|
|
11833
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentItem_'];
|
|
11173
11834
|
};
|
|
11174
11835
|
};
|
|
11175
11836
|
/** @description Bad Request */
|
|
@@ -11178,24 +11839,34 @@ export interface operations {
|
|
|
11178
11839
|
'application/json': components['schemas']['ChiftError'];
|
|
11179
11840
|
};
|
|
11180
11841
|
};
|
|
11842
|
+
/** @description Method Not Allowed */
|
|
11843
|
+
405: {
|
|
11844
|
+
content: {
|
|
11845
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11846
|
+
};
|
|
11847
|
+
};
|
|
11181
11848
|
/** @description Validation Error */
|
|
11182
11849
|
422: {
|
|
11183
11850
|
content: {
|
|
11184
11851
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11185
11852
|
};
|
|
11186
11853
|
};
|
|
11854
|
+
/** @description Bad Gateway */
|
|
11855
|
+
502: {
|
|
11856
|
+
content: {
|
|
11857
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11858
|
+
};
|
|
11859
|
+
};
|
|
11187
11860
|
};
|
|
11188
11861
|
};
|
|
11189
11862
|
/**
|
|
11190
|
-
* Get
|
|
11191
|
-
* @description Returns the
|
|
11863
|
+
* Get payment methods (PMS)
|
|
11864
|
+
* @description Returns the list of payment methods
|
|
11192
11865
|
*/
|
|
11193
|
-
|
|
11866
|
+
pms_get_payments_methods: {
|
|
11194
11867
|
parameters: {
|
|
11195
11868
|
query?: {
|
|
11196
|
-
|
|
11197
|
-
date_from?: string;
|
|
11198
|
-
date_to?: string;
|
|
11869
|
+
location_id?: string;
|
|
11199
11870
|
page?: number;
|
|
11200
11871
|
size?: number;
|
|
11201
11872
|
};
|
|
@@ -11207,7 +11878,7 @@ export interface operations {
|
|
|
11207
11878
|
/** @description Successful Response */
|
|
11208
11879
|
200: {
|
|
11209
11880
|
content: {
|
|
11210
|
-
'application/json': components['schemas']['
|
|
11881
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentMethods_'];
|
|
11211
11882
|
};
|
|
11212
11883
|
};
|
|
11213
11884
|
/** @description Bad Request */
|
|
@@ -11216,19 +11887,31 @@ export interface operations {
|
|
|
11216
11887
|
'application/json': components['schemas']['ChiftError'];
|
|
11217
11888
|
};
|
|
11218
11889
|
};
|
|
11890
|
+
/** @description Method Not Allowed */
|
|
11891
|
+
405: {
|
|
11892
|
+
content: {
|
|
11893
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11894
|
+
};
|
|
11895
|
+
};
|
|
11219
11896
|
/** @description Validation Error */
|
|
11220
11897
|
422: {
|
|
11221
11898
|
content: {
|
|
11222
11899
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11223
11900
|
};
|
|
11224
11901
|
};
|
|
11902
|
+
/** @description Bad Gateway */
|
|
11903
|
+
502: {
|
|
11904
|
+
content: {
|
|
11905
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11906
|
+
};
|
|
11907
|
+
};
|
|
11225
11908
|
};
|
|
11226
11909
|
};
|
|
11227
11910
|
/**
|
|
11228
|
-
*
|
|
11229
|
-
* @description Returns a list of
|
|
11911
|
+
* Get accounting categories (PMS)
|
|
11912
|
+
* @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
11913
|
*/
|
|
11231
|
-
|
|
11914
|
+
pms_get_accounting_categories: {
|
|
11232
11915
|
parameters: {
|
|
11233
11916
|
query?: {
|
|
11234
11917
|
page?: number;
|
|
@@ -11242,7 +11925,7 @@ export interface operations {
|
|
|
11242
11925
|
/** @description Successful Response */
|
|
11243
11926
|
200: {
|
|
11244
11927
|
content: {
|
|
11245
|
-
'application/json': components['schemas']['
|
|
11928
|
+
'application/json': components['schemas']['ChiftPage_PMSAccountingCategoryItem_'];
|
|
11246
11929
|
};
|
|
11247
11930
|
};
|
|
11248
11931
|
/** @description Bad Request */
|
|
@@ -11251,41 +11934,45 @@ export interface operations {
|
|
|
11251
11934
|
'application/json': components['schemas']['ChiftError'];
|
|
11252
11935
|
};
|
|
11253
11936
|
};
|
|
11937
|
+
/** @description Method Not Allowed */
|
|
11938
|
+
405: {
|
|
11939
|
+
content: {
|
|
11940
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11941
|
+
};
|
|
11942
|
+
};
|
|
11254
11943
|
/** @description Validation Error */
|
|
11255
11944
|
422: {
|
|
11256
11945
|
content: {
|
|
11257
11946
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11258
11947
|
};
|
|
11259
11948
|
};
|
|
11949
|
+
/** @description Bad Gateway */
|
|
11950
|
+
502: {
|
|
11951
|
+
content: {
|
|
11952
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11953
|
+
};
|
|
11954
|
+
};
|
|
11260
11955
|
};
|
|
11261
11956
|
};
|
|
11262
11957
|
/**
|
|
11263
|
-
*
|
|
11264
|
-
* @description Returns
|
|
11958
|
+
* Get closure info for a specific day (PMS)
|
|
11959
|
+
* @description Returns whether the closure was already done for a specific day or not
|
|
11265
11960
|
*/
|
|
11266
|
-
|
|
11961
|
+
pms_get_closure: {
|
|
11267
11962
|
parameters: {
|
|
11268
11963
|
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;
|
|
11964
|
+
location_id?: string;
|
|
11279
11965
|
};
|
|
11280
11966
|
path: {
|
|
11281
11967
|
consumer_id: string;
|
|
11968
|
+
date: string;
|
|
11282
11969
|
};
|
|
11283
11970
|
};
|
|
11284
11971
|
responses: {
|
|
11285
11972
|
/** @description Successful Response */
|
|
11286
11973
|
200: {
|
|
11287
11974
|
content: {
|
|
11288
|
-
'application/json': components['schemas']['
|
|
11975
|
+
'application/json': components['schemas']['PMSClosureItem'];
|
|
11289
11976
|
};
|
|
11290
11977
|
};
|
|
11291
11978
|
/** @description Bad Request */
|
|
@@ -11294,12 +11981,24 @@ export interface operations {
|
|
|
11294
11981
|
'application/json': components['schemas']['ChiftError'];
|
|
11295
11982
|
};
|
|
11296
11983
|
};
|
|
11984
|
+
/** @description Method Not Allowed */
|
|
11985
|
+
405: {
|
|
11986
|
+
content: {
|
|
11987
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11988
|
+
};
|
|
11989
|
+
};
|
|
11297
11990
|
/** @description Validation Error */
|
|
11298
11991
|
422: {
|
|
11299
11992
|
content: {
|
|
11300
11993
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11301
11994
|
};
|
|
11302
11995
|
};
|
|
11996
|
+
/** @description Bad Gateway */
|
|
11997
|
+
502: {
|
|
11998
|
+
content: {
|
|
11999
|
+
'application/json': components['schemas']['ChiftError'];
|
|
12000
|
+
};
|
|
12001
|
+
};
|
|
11303
12002
|
};
|
|
11304
12003
|
};
|
|
11305
12004
|
/**
|