@chift/chift-nodejs 1.0.14 → 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/api.d.ts +1110 -265
- package/dist/src/modules/consumer.d.ts +221 -52
- package/dist/src/modules/consumer.js +3 -0
- package/dist/src/modules/consumers.d.ts +1109 -264
- package/dist/src/modules/integrations.d.ts +1 -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 +884 -208
- package/dist/src/types/public-api/schema.d.ts +984 -292
- 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
|
@@ -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
|
|
@@ -1106,7 +1152,7 @@ export interface components {
|
|
|
1106
1152
|
* @description An enumeration.
|
|
1107
1153
|
* @enum {unknown}
|
|
1108
1154
|
*/
|
|
1109
|
-
Api: 'Point of Sale' | 'eCommerce' | 'Accounting' | 'Invoicing' | 'Communication' | 'Banking' | 'Custom' | 'Payment';
|
|
1155
|
+
Api: 'Point of Sale' | 'eCommerce' | 'Accounting' | 'Invoicing' | 'Communication' | 'Banking' | 'Custom' | 'Payment' | 'Property Management System';
|
|
1110
1156
|
/** AttachmentItem */
|
|
1111
1157
|
AttachmentItem: {
|
|
1112
1158
|
/** Base64 String */
|
|
@@ -1248,6 +1294,23 @@ export interface components {
|
|
|
1248
1294
|
*/
|
|
1249
1295
|
execution_date: string;
|
|
1250
1296
|
};
|
|
1297
|
+
/** BookYear */
|
|
1298
|
+
BookYear: {
|
|
1299
|
+
/** Name */
|
|
1300
|
+
name: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* Start
|
|
1303
|
+
* Format: date
|
|
1304
|
+
*/
|
|
1305
|
+
start: string;
|
|
1306
|
+
/**
|
|
1307
|
+
* End
|
|
1308
|
+
* Format: date
|
|
1309
|
+
*/
|
|
1310
|
+
end: string;
|
|
1311
|
+
/** Closed */
|
|
1312
|
+
closed: boolean;
|
|
1313
|
+
};
|
|
1251
1314
|
/**
|
|
1252
1315
|
* BoolParam
|
|
1253
1316
|
* @description An enumeration.
|
|
@@ -1394,6 +1457,17 @@ export interface components {
|
|
|
1394
1457
|
/** Size */
|
|
1395
1458
|
size: number;
|
|
1396
1459
|
};
|
|
1460
|
+
/** ChiftPage[BookYear] */
|
|
1461
|
+
ChiftPage_BookYear_: {
|
|
1462
|
+
/** Items */
|
|
1463
|
+
items: components['schemas']['BookYear'][];
|
|
1464
|
+
/** Total */
|
|
1465
|
+
total: number;
|
|
1466
|
+
/** Page */
|
|
1467
|
+
page: number;
|
|
1468
|
+
/** Size */
|
|
1469
|
+
size: number;
|
|
1470
|
+
};
|
|
1397
1471
|
/** ChiftPage[CategoryItem] */
|
|
1398
1472
|
ChiftPage_CategoryItem_: {
|
|
1399
1473
|
/** Items */
|
|
@@ -1570,10 +1644,21 @@ export interface components {
|
|
|
1570
1644
|
/** Size */
|
|
1571
1645
|
size: number;
|
|
1572
1646
|
};
|
|
1573
|
-
/** ChiftPage[
|
|
1574
|
-
|
|
1647
|
+
/** ChiftPage[OutstandingItem] */
|
|
1648
|
+
ChiftPage_OutstandingItem_: {
|
|
1649
|
+
/** Items */
|
|
1650
|
+
items: components['schemas']['OutstandingItem'][];
|
|
1651
|
+
/** Total */
|
|
1652
|
+
total: number;
|
|
1653
|
+
/** Page */
|
|
1654
|
+
page: number;
|
|
1655
|
+
/** Size */
|
|
1656
|
+
size: number;
|
|
1657
|
+
};
|
|
1658
|
+
/** ChiftPage[PMSAccountingCategoryItem] */
|
|
1659
|
+
ChiftPage_PMSAccountingCategoryItem_: {
|
|
1575
1660
|
/** Items */
|
|
1576
|
-
items: components['schemas']['
|
|
1661
|
+
items: components['schemas']['PMSAccountingCategoryItem'][];
|
|
1577
1662
|
/** Total */
|
|
1578
1663
|
total: number;
|
|
1579
1664
|
/** Page */
|
|
@@ -1581,10 +1666,43 @@ export interface components {
|
|
|
1581
1666
|
/** Size */
|
|
1582
1667
|
size: number;
|
|
1583
1668
|
};
|
|
1584
|
-
/** ChiftPage[
|
|
1585
|
-
|
|
1669
|
+
/** ChiftPage[PMSLocationItem] */
|
|
1670
|
+
ChiftPage_PMSLocationItem_: {
|
|
1586
1671
|
/** Items */
|
|
1587
|
-
items: components['schemas']['
|
|
1672
|
+
items: components['schemas']['PMSLocationItem'][];
|
|
1673
|
+
/** Total */
|
|
1674
|
+
total: number;
|
|
1675
|
+
/** Page */
|
|
1676
|
+
page: number;
|
|
1677
|
+
/** Size */
|
|
1678
|
+
size: number;
|
|
1679
|
+
};
|
|
1680
|
+
/** ChiftPage[PMSOrderItem] */
|
|
1681
|
+
ChiftPage_PMSOrderItem_: {
|
|
1682
|
+
/** Items */
|
|
1683
|
+
items: components['schemas']['PMSOrderItem'][];
|
|
1684
|
+
/** Total */
|
|
1685
|
+
total: number;
|
|
1686
|
+
/** Page */
|
|
1687
|
+
page: number;
|
|
1688
|
+
/** Size */
|
|
1689
|
+
size: number;
|
|
1690
|
+
};
|
|
1691
|
+
/** ChiftPage[PMSPaymentItem] */
|
|
1692
|
+
ChiftPage_PMSPaymentItem_: {
|
|
1693
|
+
/** Items */
|
|
1694
|
+
items: components['schemas']['PMSPaymentItem'][];
|
|
1695
|
+
/** Total */
|
|
1696
|
+
total: number;
|
|
1697
|
+
/** Page */
|
|
1698
|
+
page: number;
|
|
1699
|
+
/** Size */
|
|
1700
|
+
size: number;
|
|
1701
|
+
};
|
|
1702
|
+
/** ChiftPage[PMSPaymentMethods] */
|
|
1703
|
+
ChiftPage_PMSPaymentMethods_: {
|
|
1704
|
+
/** Items */
|
|
1705
|
+
items: components['schemas']['PMSPaymentMethods'][];
|
|
1588
1706
|
/** Total */
|
|
1589
1707
|
total: number;
|
|
1590
1708
|
/** Page */
|
|
@@ -1614,10 +1732,21 @@ export interface components {
|
|
|
1614
1732
|
/** Size */
|
|
1615
1733
|
size: number;
|
|
1616
1734
|
};
|
|
1617
|
-
/** ChiftPage[
|
|
1618
|
-
|
|
1735
|
+
/** ChiftPage[POSOrderItem] */
|
|
1736
|
+
ChiftPage_POSOrderItem_: {
|
|
1619
1737
|
/** Items */
|
|
1620
|
-
items: components['schemas']['
|
|
1738
|
+
items: components['schemas']['POSOrderItem'][];
|
|
1739
|
+
/** Total */
|
|
1740
|
+
total: number;
|
|
1741
|
+
/** Page */
|
|
1742
|
+
page: number;
|
|
1743
|
+
/** Size */
|
|
1744
|
+
size: number;
|
|
1745
|
+
};
|
|
1746
|
+
/** ChiftPage[POSPaymentItem] */
|
|
1747
|
+
ChiftPage_POSPaymentItem_: {
|
|
1748
|
+
/** Items */
|
|
1749
|
+
items: components['schemas']['POSPaymentItem'][];
|
|
1621
1750
|
/** Total */
|
|
1622
1751
|
total: number;
|
|
1623
1752
|
/** Page */
|
|
@@ -1625,10 +1754,10 @@ export interface components {
|
|
|
1625
1754
|
/** Size */
|
|
1626
1755
|
size: number;
|
|
1627
1756
|
};
|
|
1628
|
-
/** ChiftPage[
|
|
1629
|
-
|
|
1757
|
+
/** ChiftPage[POSProductItem] */
|
|
1758
|
+
ChiftPage_POSProductItem_: {
|
|
1630
1759
|
/** Items */
|
|
1631
|
-
items: components['schemas']['
|
|
1760
|
+
items: components['schemas']['POSProductItem'][];
|
|
1632
1761
|
/** Total */
|
|
1633
1762
|
total: number;
|
|
1634
1763
|
/** Page */
|
|
@@ -2877,6 +3006,10 @@ export interface components {
|
|
|
2877
3006
|
* @default true
|
|
2878
3007
|
*/
|
|
2879
3008
|
selected?: boolean;
|
|
3009
|
+
/** Vat */
|
|
3010
|
+
vat?: string;
|
|
3011
|
+
/** Company Number */
|
|
3012
|
+
company_number?: string;
|
|
2880
3013
|
};
|
|
2881
3014
|
/** GenericJournalEntry */
|
|
2882
3015
|
GenericJournalEntry: {
|
|
@@ -3169,6 +3302,8 @@ export interface components {
|
|
|
3169
3302
|
*/
|
|
3170
3303
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3171
3304
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3305
|
+
/** Shipping Country */
|
|
3306
|
+
shipping_country?: string;
|
|
3172
3307
|
/** Lines */
|
|
3173
3308
|
lines: components['schemas']['InvoiceLineItemInMonoAnalyticPlan'][];
|
|
3174
3309
|
};
|
|
@@ -3233,6 +3368,8 @@ export interface components {
|
|
|
3233
3368
|
*/
|
|
3234
3369
|
invoice_correction?: components['schemas']['InvoiceCorrection'];
|
|
3235
3370
|
nl_payment_terms_split?: components['schemas']['NlPaymentTermsSplit'];
|
|
3371
|
+
/** Shipping Country */
|
|
3372
|
+
shipping_country?: string;
|
|
3236
3373
|
/** Lines */
|
|
3237
3374
|
lines: components['schemas']['InvoiceLineItemInMultiAnalyticPlans'][];
|
|
3238
3375
|
};
|
|
@@ -3812,38 +3949,6 @@ export interface components {
|
|
|
3812
3949
|
* @enum {string}
|
|
3813
3950
|
*/
|
|
3814
3951
|
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
3952
|
/** Journal */
|
|
3848
3953
|
Journal: {
|
|
3849
3954
|
/** Id */
|
|
@@ -4329,63 +4434,6 @@ export interface components {
|
|
|
4329
4434
|
*/
|
|
4330
4435
|
id: string;
|
|
4331
4436
|
};
|
|
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
4437
|
/** OrderItemIn */
|
|
4390
4438
|
OrderItemIn: {
|
|
4391
4439
|
customer: components['schemas']['OrderCustomerItem'];
|
|
@@ -4438,6 +4486,11 @@ export interface components {
|
|
|
4438
4486
|
* Format: date-time
|
|
4439
4487
|
*/
|
|
4440
4488
|
confirmed_on?: string;
|
|
4489
|
+
/**
|
|
4490
|
+
* Delivery Date
|
|
4491
|
+
* Format: date-time
|
|
4492
|
+
*/
|
|
4493
|
+
delivery_date?: string;
|
|
4441
4494
|
/**
|
|
4442
4495
|
* Cancelled On
|
|
4443
4496
|
* Format: date-time
|
|
@@ -4611,6 +4664,11 @@ export interface components {
|
|
|
4611
4664
|
sku?: string;
|
|
4612
4665
|
/** Name */
|
|
4613
4666
|
name: string;
|
|
4667
|
+
/**
|
|
4668
|
+
* Categories
|
|
4669
|
+
* @default []
|
|
4670
|
+
*/
|
|
4671
|
+
categories?: components['schemas']['app__routers__commerce__ProductCategoryItem'][];
|
|
4614
4672
|
};
|
|
4615
4673
|
/** OrderPaymentMethods */
|
|
4616
4674
|
OrderPaymentMethods: {
|
|
@@ -4661,13 +4719,18 @@ export interface components {
|
|
|
4661
4719
|
* @default []
|
|
4662
4720
|
*/
|
|
4663
4721
|
shipping_refunds?: components['schemas']['ShippingRefund'][];
|
|
4722
|
+
/**
|
|
4723
|
+
* Transactions
|
|
4724
|
+
* @default []
|
|
4725
|
+
*/
|
|
4726
|
+
transactions?: components['schemas']['OrderTransactions'][];
|
|
4664
4727
|
};
|
|
4665
4728
|
/**
|
|
4666
4729
|
* OrderStatus
|
|
4667
4730
|
* @description An enumeration.
|
|
4668
4731
|
* @enum {string}
|
|
4669
4732
|
*/
|
|
4670
|
-
OrderStatus: 'cancelled' | 'draft' | 'confirmed' | 'shipped' | 'refunded';
|
|
4733
|
+
OrderStatus: 'cancelled_unpaid' | 'cancelled' | 'draft' | 'confirmed' | 'shipped' | 'refunded';
|
|
4671
4734
|
/** OrderTransactions */
|
|
4672
4735
|
OrderTransactions: {
|
|
4673
4736
|
/**
|
|
@@ -4733,63 +4796,388 @@ export interface components {
|
|
|
4733
4796
|
* @enum {string}
|
|
4734
4797
|
*/
|
|
4735
4798
|
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: {
|
|
4799
|
+
/** PMSAccountingCategoryItem */
|
|
4800
|
+
PMSAccountingCategoryItem: {
|
|
4750
4801
|
/** Id */
|
|
4751
4802
|
id: string;
|
|
4752
|
-
/**
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
|
|
4803
|
+
/**
|
|
4804
|
+
* Source Ref
|
|
4805
|
+
* @description Technical id in the target software
|
|
4806
|
+
*/
|
|
4807
|
+
source_ref: components['schemas']['Ref'];
|
|
4756
4808
|
/** Name */
|
|
4757
4809
|
name: string;
|
|
4758
|
-
/** Phone */
|
|
4759
|
-
phone?: string;
|
|
4760
|
-
/** Email */
|
|
4761
|
-
email?: string;
|
|
4762
4810
|
/**
|
|
4763
|
-
*
|
|
4764
|
-
*
|
|
4811
|
+
* Id Parent
|
|
4812
|
+
* @description Indicates if the category belongs to a parent category
|
|
4765
4813
|
*/
|
|
4766
|
-
|
|
4767
|
-
/** Addresses */
|
|
4768
|
-
addresses?: components['schemas']['AddressItem'][];
|
|
4769
|
-
/** Loyalty */
|
|
4770
|
-
loyalty?: number;
|
|
4814
|
+
id_parent?: string;
|
|
4771
4815
|
/**
|
|
4772
|
-
*
|
|
4773
|
-
*
|
|
4774
|
-
* @description Birthdate
|
|
4816
|
+
* Code
|
|
4817
|
+
* @description Code assigned to the category
|
|
4775
4818
|
*/
|
|
4776
|
-
|
|
4777
|
-
};
|
|
4778
|
-
/** POSLocationItem */
|
|
4779
|
-
POSLocationItem: {
|
|
4780
|
-
/** Id */
|
|
4781
|
-
id: string;
|
|
4782
|
-
/** Name */
|
|
4783
|
-
name: string;
|
|
4819
|
+
code?: string;
|
|
4784
4820
|
/**
|
|
4785
|
-
*
|
|
4786
|
-
* @description
|
|
4821
|
+
* Ledger Account Code
|
|
4822
|
+
* @description Ledger account code assigned to the category
|
|
4787
4823
|
*/
|
|
4788
|
-
|
|
4789
|
-
|
|
4790
|
-
|
|
4791
|
-
|
|
4792
|
-
|
|
4824
|
+
ledger_account_code?: string;
|
|
4825
|
+
/**
|
|
4826
|
+
* Posting Account Code
|
|
4827
|
+
* @description Posting account code assigned to the category
|
|
4828
|
+
*/
|
|
4829
|
+
posting_account_code?: string;
|
|
4830
|
+
};
|
|
4831
|
+
/** PMSClosureItem */
|
|
4832
|
+
PMSClosureItem: {
|
|
4833
|
+
/**
|
|
4834
|
+
* Date
|
|
4835
|
+
* Format: date
|
|
4836
|
+
*/
|
|
4837
|
+
date: string;
|
|
4838
|
+
status: components['schemas']['ClosureStates'];
|
|
4839
|
+
};
|
|
4840
|
+
/** PMSLocationItem */
|
|
4841
|
+
PMSLocationItem: {
|
|
4842
|
+
/** Id */
|
|
4843
|
+
id: string;
|
|
4844
|
+
/** Name */
|
|
4845
|
+
name: string;
|
|
4846
|
+
/**
|
|
4847
|
+
* Timezone
|
|
4848
|
+
* @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
|
|
4849
|
+
*/
|
|
4850
|
+
timezone?: string;
|
|
4851
|
+
address?: components['schemas']['AddressItem'];
|
|
4852
|
+
};
|
|
4853
|
+
/** PMSOrderItem */
|
|
4854
|
+
PMSOrderItem: {
|
|
4855
|
+
/** Id */
|
|
4856
|
+
id: string;
|
|
4857
|
+
/**
|
|
4858
|
+
* Source Ref
|
|
4859
|
+
* @description Technical id in the target software
|
|
4860
|
+
*/
|
|
4861
|
+
source_ref: components['schemas']['Ref'];
|
|
4862
|
+
/** Order Number */
|
|
4863
|
+
order_number?: string;
|
|
4864
|
+
/**
|
|
4865
|
+
* Creation Date
|
|
4866
|
+
* Format: date-time
|
|
4867
|
+
*/
|
|
4868
|
+
creation_date: string;
|
|
4869
|
+
/**
|
|
4870
|
+
* Closing Date
|
|
4871
|
+
* Format: date-time
|
|
4872
|
+
*/
|
|
4873
|
+
closing_date?: string;
|
|
4874
|
+
/**
|
|
4875
|
+
* Service Date
|
|
4876
|
+
* Format: date-time
|
|
4877
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
4878
|
+
*/
|
|
4879
|
+
service_date?: string;
|
|
4880
|
+
/**
|
|
4881
|
+
* Device Id
|
|
4882
|
+
* @description ID of device that created the order
|
|
4883
|
+
*/
|
|
4884
|
+
device_id?: string;
|
|
4885
|
+
/** Total */
|
|
4886
|
+
total: number;
|
|
4887
|
+
/** Tax Amount */
|
|
4888
|
+
tax_amount: number;
|
|
4889
|
+
/** Total Discount */
|
|
4890
|
+
total_discount?: number;
|
|
4891
|
+
/** Total Refund */
|
|
4892
|
+
total_refund?: number;
|
|
4893
|
+
/**
|
|
4894
|
+
* Total Tip
|
|
4895
|
+
* @default 0
|
|
4896
|
+
*/
|
|
4897
|
+
total_tip?: number;
|
|
4898
|
+
/** Currency */
|
|
4899
|
+
currency?: string;
|
|
4900
|
+
/** Country */
|
|
4901
|
+
country?: string;
|
|
4902
|
+
/** Loyalty */
|
|
4903
|
+
loyalty?: number;
|
|
4904
|
+
/** Customer Id */
|
|
4905
|
+
customer_id?: string;
|
|
4906
|
+
/** Location Id */
|
|
4907
|
+
location_id?: string;
|
|
4908
|
+
/** Taxes */
|
|
4909
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4910
|
+
/** Items */
|
|
4911
|
+
items: components['schemas']['PMSOrderLineItem'][];
|
|
4912
|
+
/**
|
|
4913
|
+
* Service Id
|
|
4914
|
+
* @description Reference to the service related to this order
|
|
4915
|
+
*/
|
|
4916
|
+
service_id?: string;
|
|
4917
|
+
};
|
|
4918
|
+
/** PMSOrderLineItem */
|
|
4919
|
+
PMSOrderLineItem: {
|
|
4920
|
+
/** Id */
|
|
4921
|
+
id: string;
|
|
4922
|
+
/**
|
|
4923
|
+
* Source Ref
|
|
4924
|
+
* @description Technical id in the target software
|
|
4925
|
+
*/
|
|
4926
|
+
source_ref: components['schemas']['Ref'];
|
|
4927
|
+
/** Quantity */
|
|
4928
|
+
quantity: number;
|
|
4929
|
+
/** Unit Price */
|
|
4930
|
+
unit_price: number;
|
|
4931
|
+
/** Total */
|
|
4932
|
+
total: number;
|
|
4933
|
+
/** Tax Amount */
|
|
4934
|
+
tax_amount: number;
|
|
4935
|
+
/** Tax Rate */
|
|
4936
|
+
tax_rate?: number;
|
|
4937
|
+
/** Description */
|
|
4938
|
+
description?: string;
|
|
4939
|
+
/**
|
|
4940
|
+
* Discounts
|
|
4941
|
+
* @default []
|
|
4942
|
+
*/
|
|
4943
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
4944
|
+
/**
|
|
4945
|
+
* Product Id
|
|
4946
|
+
* @description Reference to the product related to this item
|
|
4947
|
+
*/
|
|
4948
|
+
product_id?: string;
|
|
4949
|
+
/**
|
|
4950
|
+
* Accounting Category Id
|
|
4951
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
4952
|
+
*/
|
|
4953
|
+
accounting_category_id?: string;
|
|
4954
|
+
};
|
|
4955
|
+
/** PMSPaymentItem */
|
|
4956
|
+
PMSPaymentItem: {
|
|
4957
|
+
/** Id */
|
|
4958
|
+
id?: string;
|
|
4959
|
+
/**
|
|
4960
|
+
* Source Ref
|
|
4961
|
+
* @description Technical id in the target software
|
|
4962
|
+
*/
|
|
4963
|
+
source_ref: components['schemas']['Ref'];
|
|
4964
|
+
/** Payment Method Id */
|
|
4965
|
+
payment_method_id?: string;
|
|
4966
|
+
/** Payment Method Name */
|
|
4967
|
+
payment_method_name?: string;
|
|
4968
|
+
/** Total */
|
|
4969
|
+
total: number;
|
|
4970
|
+
/**
|
|
4971
|
+
* Tip
|
|
4972
|
+
* @default 0
|
|
4973
|
+
*/
|
|
4974
|
+
tip?: number;
|
|
4975
|
+
/** @default Unknown */
|
|
4976
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
4977
|
+
/** Currency */
|
|
4978
|
+
currency?: string;
|
|
4979
|
+
/**
|
|
4980
|
+
* Date
|
|
4981
|
+
* Format: date-time
|
|
4982
|
+
*/
|
|
4983
|
+
date?: string;
|
|
4984
|
+
};
|
|
4985
|
+
/** PMSPaymentMethods */
|
|
4986
|
+
PMSPaymentMethods: {
|
|
4987
|
+
/** Id */
|
|
4988
|
+
id: string;
|
|
4989
|
+
/**
|
|
4990
|
+
* Source Ref
|
|
4991
|
+
* @description Technical id in the target software
|
|
4992
|
+
*/
|
|
4993
|
+
source_ref: components['schemas']['Ref'];
|
|
4994
|
+
/** Name */
|
|
4995
|
+
name: string;
|
|
4996
|
+
/** Extra */
|
|
4997
|
+
extra?: string;
|
|
4998
|
+
/**
|
|
4999
|
+
* Ledger Account Code
|
|
5000
|
+
* @description Ledger account code assigned to the category
|
|
5001
|
+
*/
|
|
5002
|
+
ledger_account_code?: string;
|
|
5003
|
+
};
|
|
5004
|
+
/**
|
|
5005
|
+
* PMSStates
|
|
5006
|
+
* @description An enumeration.
|
|
5007
|
+
* @enum {unknown}
|
|
5008
|
+
*/
|
|
5009
|
+
PMSStates: 'consumed' | 'closed';
|
|
5010
|
+
/** POSCreateCustomerItem */
|
|
5011
|
+
POSCreateCustomerItem: {
|
|
5012
|
+
/** First Name */
|
|
5013
|
+
first_name: string;
|
|
5014
|
+
/** Last Name */
|
|
5015
|
+
last_name: string;
|
|
5016
|
+
/** Phone */
|
|
5017
|
+
phone?: string;
|
|
5018
|
+
/** Email */
|
|
5019
|
+
email?: string;
|
|
5020
|
+
address?: components['schemas']['PostAddressItem'];
|
|
5021
|
+
};
|
|
5022
|
+
/** POSCustomerItem */
|
|
5023
|
+
POSCustomerItem: {
|
|
5024
|
+
/** Id */
|
|
5025
|
+
id: string;
|
|
5026
|
+
/** First Name */
|
|
5027
|
+
first_name?: string;
|
|
5028
|
+
/** Last Name */
|
|
5029
|
+
last_name?: string;
|
|
5030
|
+
/** Name */
|
|
5031
|
+
name: string;
|
|
5032
|
+
/** Phone */
|
|
5033
|
+
phone?: string;
|
|
5034
|
+
/** Email */
|
|
5035
|
+
email?: string;
|
|
5036
|
+
/**
|
|
5037
|
+
* Created On
|
|
5038
|
+
* Format: date-time
|
|
5039
|
+
*/
|
|
5040
|
+
created_on?: string;
|
|
5041
|
+
/** Addresses */
|
|
5042
|
+
addresses?: components['schemas']['AddressItem'][];
|
|
5043
|
+
/** Loyalty */
|
|
5044
|
+
loyalty?: number;
|
|
5045
|
+
/**
|
|
5046
|
+
* Birthdate
|
|
5047
|
+
* Format: date
|
|
5048
|
+
* @description Birthdate
|
|
5049
|
+
*/
|
|
5050
|
+
birthdate?: string;
|
|
5051
|
+
};
|
|
5052
|
+
/** POSItem */
|
|
5053
|
+
POSItem: {
|
|
5054
|
+
/** Id */
|
|
5055
|
+
id: string;
|
|
5056
|
+
/** Quantity */
|
|
5057
|
+
quantity: number;
|
|
5058
|
+
/** Unit Price */
|
|
5059
|
+
unit_price: number;
|
|
5060
|
+
/** Total */
|
|
5061
|
+
total: number;
|
|
5062
|
+
/** Tax Amount */
|
|
5063
|
+
tax_amount: number;
|
|
5064
|
+
/** Tax Rate */
|
|
5065
|
+
tax_rate?: number;
|
|
5066
|
+
/** Description */
|
|
5067
|
+
description?: string;
|
|
5068
|
+
/**
|
|
5069
|
+
* Discounts
|
|
5070
|
+
* @default []
|
|
5071
|
+
*/
|
|
5072
|
+
discounts?: components['schemas']['models__pos_pms__DiscountItem'][];
|
|
5073
|
+
/**
|
|
5074
|
+
* Product Id
|
|
5075
|
+
* @description Reference to the product related to this item
|
|
5076
|
+
*/
|
|
5077
|
+
product_id?: string;
|
|
5078
|
+
/**
|
|
5079
|
+
* Accounting Category Id
|
|
5080
|
+
* @description Sometimes used by a POS to give a specific accounting category to an order item
|
|
5081
|
+
*/
|
|
5082
|
+
accounting_category_id?: string;
|
|
5083
|
+
};
|
|
5084
|
+
/** POSLocationItem */
|
|
5085
|
+
POSLocationItem: {
|
|
5086
|
+
/** Id */
|
|
5087
|
+
id: string;
|
|
5088
|
+
/** Name */
|
|
5089
|
+
name: string;
|
|
5090
|
+
/**
|
|
5091
|
+
* Timezone
|
|
5092
|
+
* @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
|
|
5093
|
+
*/
|
|
5094
|
+
timezone?: string;
|
|
5095
|
+
address?: components['schemas']['AddressItem'];
|
|
5096
|
+
};
|
|
5097
|
+
/** POSOrderItem */
|
|
5098
|
+
POSOrderItem: {
|
|
5099
|
+
/** Id */
|
|
5100
|
+
id: string;
|
|
5101
|
+
/** Order Number */
|
|
5102
|
+
order_number?: string;
|
|
5103
|
+
/**
|
|
5104
|
+
* Creation Date
|
|
5105
|
+
* Format: date-time
|
|
5106
|
+
*/
|
|
5107
|
+
creation_date: string;
|
|
5108
|
+
/**
|
|
5109
|
+
* Closing Date
|
|
5110
|
+
* Format: date-time
|
|
5111
|
+
*/
|
|
5112
|
+
closing_date?: string;
|
|
5113
|
+
/**
|
|
5114
|
+
* Service Date
|
|
5115
|
+
* Format: date-time
|
|
5116
|
+
* @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
|
|
5117
|
+
*/
|
|
5118
|
+
service_date?: string;
|
|
5119
|
+
/**
|
|
5120
|
+
* Device Id
|
|
5121
|
+
* @description ID of device that created the order
|
|
5122
|
+
*/
|
|
5123
|
+
device_id?: string;
|
|
5124
|
+
/** Total */
|
|
5125
|
+
total: number;
|
|
5126
|
+
/** Tax Amount */
|
|
5127
|
+
tax_amount: number;
|
|
5128
|
+
/** Total Discount */
|
|
5129
|
+
total_discount?: number;
|
|
5130
|
+
/** Total Refund */
|
|
5131
|
+
total_refund?: number;
|
|
5132
|
+
/**
|
|
5133
|
+
* Total Tip
|
|
5134
|
+
* @default 0
|
|
5135
|
+
*/
|
|
5136
|
+
total_tip?: number;
|
|
5137
|
+
/** Currency */
|
|
5138
|
+
currency?: string;
|
|
5139
|
+
/** Country */
|
|
5140
|
+
country?: string;
|
|
5141
|
+
/** Loyalty */
|
|
5142
|
+
loyalty?: number;
|
|
5143
|
+
/** Customer Id */
|
|
5144
|
+
customer_id?: string;
|
|
5145
|
+
/** Location Id */
|
|
5146
|
+
location_id?: string;
|
|
5147
|
+
/** Taxes */
|
|
5148
|
+
taxes?: components['schemas']['TotalTaxItem'][];
|
|
5149
|
+
/** Payments */
|
|
5150
|
+
payments: components['schemas']['POSPaymentItem'][];
|
|
5151
|
+
/** Items */
|
|
5152
|
+
items: components['schemas']['POSItem'][];
|
|
5153
|
+
};
|
|
5154
|
+
/** POSPaymentItem */
|
|
5155
|
+
POSPaymentItem: {
|
|
5156
|
+
/** Id */
|
|
5157
|
+
id?: string;
|
|
5158
|
+
/** Payment Method Id */
|
|
5159
|
+
payment_method_id?: string;
|
|
5160
|
+
/** Payment Method Name */
|
|
5161
|
+
payment_method_name?: string;
|
|
5162
|
+
/** Total */
|
|
5163
|
+
total: number;
|
|
5164
|
+
/**
|
|
5165
|
+
* Tip
|
|
5166
|
+
* @default 0
|
|
5167
|
+
*/
|
|
5168
|
+
tip?: number;
|
|
5169
|
+
/** @default Unknown */
|
|
5170
|
+
status?: components['schemas']['models__pos_pms__PaymentStatus'];
|
|
5171
|
+
/** Currency */
|
|
5172
|
+
currency?: string;
|
|
5173
|
+
/**
|
|
5174
|
+
* Date
|
|
5175
|
+
* Format: date-time
|
|
5176
|
+
*/
|
|
5177
|
+
date?: string;
|
|
5178
|
+
};
|
|
5179
|
+
/** POSProductItem */
|
|
5180
|
+
POSProductItem: {
|
|
4793
5181
|
/** Id */
|
|
4794
5182
|
id: string;
|
|
4795
5183
|
/**
|
|
@@ -4893,48 +5281,23 @@ export interface components {
|
|
|
4893
5281
|
dedicated_amount?: number;
|
|
4894
5282
|
/**
|
|
4895
5283
|
* Payment Date
|
|
4896
|
-
* Format: date
|
|
4897
|
-
*/
|
|
4898
|
-
payment_date: string;
|
|
4899
|
-
journal_type: components['schemas']['JournalType'];
|
|
4900
|
-
/** Journal Id */
|
|
4901
|
-
journal_id: string;
|
|
4902
|
-
/** Journal Name */
|
|
4903
|
-
journal_name: string;
|
|
4904
|
-
/**
|
|
4905
|
-
* Reconciled
|
|
4906
|
-
* @default false
|
|
4907
|
-
*/
|
|
4908
|
-
reconciled?: boolean;
|
|
4909
|
-
/** Communication */
|
|
4910
|
-
communication?: string;
|
|
4911
|
-
/** Matching Number */
|
|
4912
|
-
matching_number?: string;
|
|
4913
|
-
};
|
|
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;
|
|
5284
|
+
* Format: date
|
|
5285
|
+
*/
|
|
5286
|
+
payment_date: string;
|
|
5287
|
+
journal_type: components['schemas']['JournalType'];
|
|
5288
|
+
/** Journal Id */
|
|
5289
|
+
journal_id: string;
|
|
5290
|
+
/** Journal Name */
|
|
5291
|
+
journal_name: string;
|
|
4933
5292
|
/**
|
|
4934
|
-
*
|
|
4935
|
-
*
|
|
5293
|
+
* Reconciled
|
|
5294
|
+
* @default false
|
|
4936
5295
|
*/
|
|
4937
|
-
|
|
5296
|
+
reconciled?: boolean;
|
|
5297
|
+
/** Communication */
|
|
5298
|
+
communication?: string;
|
|
5299
|
+
/** Matching Number */
|
|
5300
|
+
matching_number?: string;
|
|
4938
5301
|
};
|
|
4939
5302
|
/** PaymentMethodItem */
|
|
4940
5303
|
PaymentMethodItem: {
|
|
@@ -6209,19 +6572,6 @@ export interface components {
|
|
|
6209
6572
|
/** Size */
|
|
6210
6573
|
size: number;
|
|
6211
6574
|
};
|
|
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
6575
|
/** ProductCategoryItem */
|
|
6226
6576
|
app__routers__pos__ProductCategoryItem: {
|
|
6227
6577
|
/** Id */
|
|
@@ -6422,6 +6772,19 @@ export interface components {
|
|
|
6422
6772
|
* @enum {string}
|
|
6423
6773
|
*/
|
|
6424
6774
|
models__invoicing__VatCodeType: 'sale' | 'purchase' | 'both' | 'unknown';
|
|
6775
|
+
/** DiscountItem */
|
|
6776
|
+
models__pos_pms__DiscountItem: {
|
|
6777
|
+
/** Name */
|
|
6778
|
+
name?: string;
|
|
6779
|
+
/** Total */
|
|
6780
|
+
total: number;
|
|
6781
|
+
};
|
|
6782
|
+
/**
|
|
6783
|
+
* PaymentStatus
|
|
6784
|
+
* @description An enumeration.
|
|
6785
|
+
* @enum {unknown}
|
|
6786
|
+
*/
|
|
6787
|
+
models__pos_pms__PaymentStatus: 'Pending' | 'Completed' | 'Canceled' | 'Failed' | 'Unknown' | 'Authorised';
|
|
6425
6788
|
};
|
|
6426
6789
|
responses: never;
|
|
6427
6790
|
parameters: never;
|
|
@@ -7520,6 +7883,40 @@ export interface operations {
|
|
|
7520
7883
|
};
|
|
7521
7884
|
};
|
|
7522
7885
|
};
|
|
7886
|
+
/** Get Bookyears */
|
|
7887
|
+
accounting_get_bookyears: {
|
|
7888
|
+
parameters: {
|
|
7889
|
+
query?: {
|
|
7890
|
+
/** @description Accounting folder ID, this needs to be passed when activating the multiple folders feature. */
|
|
7891
|
+
folder_id?: string;
|
|
7892
|
+
page?: number;
|
|
7893
|
+
size?: number;
|
|
7894
|
+
};
|
|
7895
|
+
path: {
|
|
7896
|
+
consumer_id: string;
|
|
7897
|
+
};
|
|
7898
|
+
};
|
|
7899
|
+
responses: {
|
|
7900
|
+
/** @description Successful Response */
|
|
7901
|
+
200: {
|
|
7902
|
+
content: {
|
|
7903
|
+
'application/json': components['schemas']['ChiftPage_BookYear_'];
|
|
7904
|
+
};
|
|
7905
|
+
};
|
|
7906
|
+
/** @description Bad Request */
|
|
7907
|
+
400: {
|
|
7908
|
+
content: {
|
|
7909
|
+
'application/json': components['schemas']['ChiftError'];
|
|
7910
|
+
};
|
|
7911
|
+
};
|
|
7912
|
+
/** @description Validation Error */
|
|
7913
|
+
422: {
|
|
7914
|
+
content: {
|
|
7915
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7916
|
+
};
|
|
7917
|
+
};
|
|
7918
|
+
};
|
|
7919
|
+
};
|
|
7523
7920
|
/** Get Analytic Plans */
|
|
7524
7921
|
accounting_get_analytic_plans: {
|
|
7525
7922
|
parameters: {
|
|
@@ -9346,7 +9743,7 @@ export interface operations {
|
|
|
9346
9743
|
/** @description Successful Response */
|
|
9347
9744
|
200: {
|
|
9348
9745
|
content: {
|
|
9349
|
-
'application/json': components['schemas']['
|
|
9746
|
+
'application/json': components['schemas']['ChiftPage_POSOrderItem_'];
|
|
9350
9747
|
};
|
|
9351
9748
|
};
|
|
9352
9749
|
/** @description Bad Request */
|
|
@@ -9390,7 +9787,7 @@ export interface operations {
|
|
|
9390
9787
|
/** @description Successful Response */
|
|
9391
9788
|
200: {
|
|
9392
9789
|
content: {
|
|
9393
|
-
'application/json': components['schemas']['
|
|
9790
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9394
9791
|
};
|
|
9395
9792
|
};
|
|
9396
9793
|
/** @description Bad Request */
|
|
@@ -9445,7 +9842,7 @@ export interface operations {
|
|
|
9445
9842
|
/** @description Successful Response */
|
|
9446
9843
|
200: {
|
|
9447
9844
|
content: {
|
|
9448
|
-
'application/json': components['schemas']['
|
|
9845
|
+
'application/json': components['schemas']['POSOrderItem'];
|
|
9449
9846
|
};
|
|
9450
9847
|
};
|
|
9451
9848
|
/** @description Bad Request */
|
|
@@ -9541,7 +9938,7 @@ export interface operations {
|
|
|
9541
9938
|
/** @description Successful Response */
|
|
9542
9939
|
200: {
|
|
9543
9940
|
content: {
|
|
9544
|
-
'application/json': components['schemas']['
|
|
9941
|
+
'application/json': components['schemas']['ChiftPage_POSPaymentItem_'];
|
|
9545
9942
|
};
|
|
9546
9943
|
};
|
|
9547
9944
|
/** @description Bad Request */
|
|
@@ -10285,6 +10682,8 @@ export interface operations {
|
|
|
10285
10682
|
updated_after?: string;
|
|
10286
10683
|
/** @description Include detailed information concerning refunds */
|
|
10287
10684
|
include_detailed_refunds?: components['schemas']['BoolParam'];
|
|
10685
|
+
/** @description Include detailed information about categories */
|
|
10686
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10288
10687
|
page?: number;
|
|
10289
10688
|
size?: number;
|
|
10290
10689
|
};
|
|
@@ -10355,6 +10754,10 @@ export interface operations {
|
|
|
10355
10754
|
*/
|
|
10356
10755
|
ecommerce_get_order: {
|
|
10357
10756
|
parameters: {
|
|
10757
|
+
query?: {
|
|
10758
|
+
/** @description Include detailed information about categories */
|
|
10759
|
+
include_product_categories?: components['schemas']['BoolParam'];
|
|
10760
|
+
};
|
|
10358
10761
|
path: {
|
|
10359
10762
|
order_id: string;
|
|
10360
10763
|
consumer_id: string;
|
|
@@ -10793,13 +11196,197 @@ export interface operations {
|
|
|
10793
11196
|
};
|
|
10794
11197
|
};
|
|
10795
11198
|
/**
|
|
10796
|
-
* Retrieve one product
|
|
10797
|
-
* @description Returns a product
|
|
11199
|
+
* Retrieve one product
|
|
11200
|
+
* @description Returns a product
|
|
11201
|
+
*/
|
|
11202
|
+
invoicing_get_product: {
|
|
11203
|
+
parameters: {
|
|
11204
|
+
path: {
|
|
11205
|
+
product_id: string;
|
|
11206
|
+
consumer_id: string;
|
|
11207
|
+
};
|
|
11208
|
+
};
|
|
11209
|
+
responses: {
|
|
11210
|
+
/** @description Successful Response */
|
|
11211
|
+
200: {
|
|
11212
|
+
content: {
|
|
11213
|
+
'application/json': components['schemas']['ProductItemOut'];
|
|
11214
|
+
};
|
|
11215
|
+
};
|
|
11216
|
+
/** @description Bad Request */
|
|
11217
|
+
400: {
|
|
11218
|
+
content: {
|
|
11219
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11220
|
+
};
|
|
11221
|
+
};
|
|
11222
|
+
/** @description Not Found */
|
|
11223
|
+
404: {
|
|
11224
|
+
content: {
|
|
11225
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11226
|
+
};
|
|
11227
|
+
};
|
|
11228
|
+
/** @description Validation Error */
|
|
11229
|
+
422: {
|
|
11230
|
+
content: {
|
|
11231
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11232
|
+
};
|
|
11233
|
+
};
|
|
11234
|
+
};
|
|
11235
|
+
};
|
|
11236
|
+
/**
|
|
11237
|
+
* Retrieve all opportunities
|
|
11238
|
+
* @description Returns a list of all the opportunities
|
|
11239
|
+
*/
|
|
11240
|
+
invoicing_get_opportunities: {
|
|
11241
|
+
parameters: {
|
|
11242
|
+
query?: {
|
|
11243
|
+
page?: number;
|
|
11244
|
+
size?: number;
|
|
11245
|
+
};
|
|
11246
|
+
path: {
|
|
11247
|
+
consumer_id: string;
|
|
11248
|
+
};
|
|
11249
|
+
};
|
|
11250
|
+
responses: {
|
|
11251
|
+
/** @description Successful Response */
|
|
11252
|
+
200: {
|
|
11253
|
+
content: {
|
|
11254
|
+
'application/json': components['schemas']['ChiftPage_OpportunityItem_'];
|
|
11255
|
+
};
|
|
11256
|
+
};
|
|
11257
|
+
/** @description Bad Request */
|
|
11258
|
+
400: {
|
|
11259
|
+
content: {
|
|
11260
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11261
|
+
};
|
|
11262
|
+
};
|
|
11263
|
+
/** @description Validation Error */
|
|
11264
|
+
422: {
|
|
11265
|
+
content: {
|
|
11266
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11267
|
+
};
|
|
11268
|
+
};
|
|
11269
|
+
};
|
|
11270
|
+
};
|
|
11271
|
+
/**
|
|
11272
|
+
* Retrieve one opportunity
|
|
11273
|
+
* @description Returns an opportunity
|
|
11274
|
+
*/
|
|
11275
|
+
invoicing_get_opportunity: {
|
|
11276
|
+
parameters: {
|
|
11277
|
+
path: {
|
|
11278
|
+
opportunity_id: string;
|
|
11279
|
+
consumer_id: string;
|
|
11280
|
+
};
|
|
11281
|
+
};
|
|
11282
|
+
responses: {
|
|
11283
|
+
/** @description Successful Response */
|
|
11284
|
+
200: {
|
|
11285
|
+
content: {
|
|
11286
|
+
'application/json': components['schemas']['OpportunityItem'];
|
|
11287
|
+
};
|
|
11288
|
+
};
|
|
11289
|
+
/** @description Bad Request */
|
|
11290
|
+
400: {
|
|
11291
|
+
content: {
|
|
11292
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11293
|
+
};
|
|
11294
|
+
};
|
|
11295
|
+
/** @description Not Found */
|
|
11296
|
+
404: {
|
|
11297
|
+
content: {
|
|
11298
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11299
|
+
};
|
|
11300
|
+
};
|
|
11301
|
+
/** @description Validation Error */
|
|
11302
|
+
422: {
|
|
11303
|
+
content: {
|
|
11304
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11305
|
+
};
|
|
11306
|
+
};
|
|
11307
|
+
};
|
|
11308
|
+
};
|
|
11309
|
+
/**
|
|
11310
|
+
* Retrieve all contacts
|
|
11311
|
+
* @description Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.
|
|
11312
|
+
*/
|
|
11313
|
+
invoicing_get_contacts: {
|
|
11314
|
+
parameters: {
|
|
11315
|
+
query?: {
|
|
11316
|
+
/** @description Filter based on the type of the contact (e.g. supplier/customer/prospect). */
|
|
11317
|
+
contact_type?: components['schemas']['ContactType'];
|
|
11318
|
+
page?: number;
|
|
11319
|
+
size?: number;
|
|
11320
|
+
};
|
|
11321
|
+
path: {
|
|
11322
|
+
consumer_id: string;
|
|
11323
|
+
};
|
|
11324
|
+
};
|
|
11325
|
+
responses: {
|
|
11326
|
+
/** @description Successful Response */
|
|
11327
|
+
200: {
|
|
11328
|
+
content: {
|
|
11329
|
+
'application/json': components['schemas']['ChiftPage_ContactItemOut_'];
|
|
11330
|
+
};
|
|
11331
|
+
};
|
|
11332
|
+
/** @description Bad Request */
|
|
11333
|
+
400: {
|
|
11334
|
+
content: {
|
|
11335
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11336
|
+
};
|
|
11337
|
+
};
|
|
11338
|
+
/** @description Validation Error */
|
|
11339
|
+
422: {
|
|
11340
|
+
content: {
|
|
11341
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11342
|
+
};
|
|
11343
|
+
};
|
|
11344
|
+
};
|
|
11345
|
+
};
|
|
11346
|
+
/**
|
|
11347
|
+
* Create a contact
|
|
11348
|
+
* @description Create a new contact.
|
|
11349
|
+
*/
|
|
11350
|
+
invoicing_post_contacts: {
|
|
11351
|
+
parameters: {
|
|
11352
|
+
path: {
|
|
11353
|
+
consumer_id: string;
|
|
11354
|
+
};
|
|
11355
|
+
};
|
|
11356
|
+
requestBody: {
|
|
11357
|
+
content: {
|
|
11358
|
+
'application/json': components['schemas']['ContactItemIn'];
|
|
11359
|
+
};
|
|
11360
|
+
};
|
|
11361
|
+
responses: {
|
|
11362
|
+
/** @description Successful Response */
|
|
11363
|
+
200: {
|
|
11364
|
+
content: {
|
|
11365
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
11366
|
+
};
|
|
11367
|
+
};
|
|
11368
|
+
/** @description Bad Request */
|
|
11369
|
+
400: {
|
|
11370
|
+
content: {
|
|
11371
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11372
|
+
};
|
|
11373
|
+
};
|
|
11374
|
+
/** @description Validation Error */
|
|
11375
|
+
422: {
|
|
11376
|
+
content: {
|
|
11377
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11378
|
+
};
|
|
11379
|
+
};
|
|
11380
|
+
};
|
|
11381
|
+
};
|
|
11382
|
+
/**
|
|
11383
|
+
* Retrieve one contact
|
|
11384
|
+
* @description Returns a contact
|
|
10798
11385
|
*/
|
|
10799
|
-
|
|
11386
|
+
invoicing_get_contact: {
|
|
10800
11387
|
parameters: {
|
|
10801
11388
|
path: {
|
|
10802
|
-
|
|
11389
|
+
contact_id: string;
|
|
10803
11390
|
consumer_id: string;
|
|
10804
11391
|
};
|
|
10805
11392
|
};
|
|
@@ -10807,7 +11394,7 @@ export interface operations {
|
|
|
10807
11394
|
/** @description Successful Response */
|
|
10808
11395
|
200: {
|
|
10809
11396
|
content: {
|
|
10810
|
-
'application/json': components['schemas']['
|
|
11397
|
+
'application/json': components['schemas']['ContactItemOut'];
|
|
10811
11398
|
};
|
|
10812
11399
|
};
|
|
10813
11400
|
/** @description Bad Request */
|
|
@@ -10831,10 +11418,10 @@ export interface operations {
|
|
|
10831
11418
|
};
|
|
10832
11419
|
};
|
|
10833
11420
|
/**
|
|
10834
|
-
*
|
|
10835
|
-
* @description Returns
|
|
11421
|
+
* Get list of financial institutions
|
|
11422
|
+
* @description Returns the list of financial institutions the user consent access to
|
|
10836
11423
|
*/
|
|
10837
|
-
|
|
11424
|
+
banking_get_financial_institutions: {
|
|
10838
11425
|
parameters: {
|
|
10839
11426
|
query?: {
|
|
10840
11427
|
page?: number;
|
|
@@ -10848,7 +11435,7 @@ export interface operations {
|
|
|
10848
11435
|
/** @description Successful Response */
|
|
10849
11436
|
200: {
|
|
10850
11437
|
content: {
|
|
10851
|
-
'application/json': components['schemas']['
|
|
11438
|
+
'application/json': components['schemas']['Page_BankingFinancialInstitutionItem_'];
|
|
10852
11439
|
};
|
|
10853
11440
|
};
|
|
10854
11441
|
/** @description Bad Request */
|
|
@@ -10866,13 +11453,16 @@ export interface operations {
|
|
|
10866
11453
|
};
|
|
10867
11454
|
};
|
|
10868
11455
|
/**
|
|
10869
|
-
*
|
|
10870
|
-
* @description Returns
|
|
11456
|
+
* Get list of banking accounts
|
|
11457
|
+
* @description Returns the list of banking accounts
|
|
10871
11458
|
*/
|
|
10872
|
-
|
|
11459
|
+
banking_get_accounts: {
|
|
10873
11460
|
parameters: {
|
|
11461
|
+
query?: {
|
|
11462
|
+
page?: number;
|
|
11463
|
+
size?: number;
|
|
11464
|
+
};
|
|
10874
11465
|
path: {
|
|
10875
|
-
opportunity_id: string;
|
|
10876
11466
|
consumer_id: string;
|
|
10877
11467
|
};
|
|
10878
11468
|
};
|
|
@@ -10880,7 +11470,7 @@ export interface operations {
|
|
|
10880
11470
|
/** @description Successful Response */
|
|
10881
11471
|
200: {
|
|
10882
11472
|
content: {
|
|
10883
|
-
'application/json': components['schemas']['
|
|
11473
|
+
'application/json': components['schemas']['Page_BankingAccountItem_'];
|
|
10884
11474
|
};
|
|
10885
11475
|
};
|
|
10886
11476
|
/** @description Bad Request */
|
|
@@ -10889,12 +11479,6 @@ export interface operations {
|
|
|
10889
11479
|
'application/json': components['schemas']['ChiftError'];
|
|
10890
11480
|
};
|
|
10891
11481
|
};
|
|
10892
|
-
/** @description Not Found */
|
|
10893
|
-
404: {
|
|
10894
|
-
content: {
|
|
10895
|
-
'application/json': components['schemas']['ChiftError'];
|
|
10896
|
-
};
|
|
10897
|
-
};
|
|
10898
11482
|
/** @description Validation Error */
|
|
10899
11483
|
422: {
|
|
10900
11484
|
content: {
|
|
@@ -10904,26 +11488,28 @@ export interface operations {
|
|
|
10904
11488
|
};
|
|
10905
11489
|
};
|
|
10906
11490
|
/**
|
|
10907
|
-
*
|
|
10908
|
-
* @description Returns
|
|
11491
|
+
* Get list of financial transactions
|
|
11492
|
+
* @description Returns the list of transactions of an account
|
|
10909
11493
|
*/
|
|
10910
|
-
|
|
11494
|
+
banking_get_account_transactions: {
|
|
10911
11495
|
parameters: {
|
|
10912
11496
|
query?: {
|
|
10913
|
-
|
|
10914
|
-
|
|
11497
|
+
date_from?: string;
|
|
11498
|
+
date_to?: string;
|
|
11499
|
+
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
10915
11500
|
page?: number;
|
|
10916
11501
|
size?: number;
|
|
10917
11502
|
};
|
|
10918
11503
|
path: {
|
|
10919
11504
|
consumer_id: string;
|
|
11505
|
+
account_id: string;
|
|
10920
11506
|
};
|
|
10921
11507
|
};
|
|
10922
11508
|
responses: {
|
|
10923
11509
|
/** @description Successful Response */
|
|
10924
11510
|
200: {
|
|
10925
11511
|
content: {
|
|
10926
|
-
'application/json': components['schemas']['
|
|
11512
|
+
'application/json': components['schemas']['Page_BankingTransactionItem_'];
|
|
10927
11513
|
};
|
|
10928
11514
|
};
|
|
10929
11515
|
/** @description Bad Request */
|
|
@@ -10941,25 +11527,27 @@ export interface operations {
|
|
|
10941
11527
|
};
|
|
10942
11528
|
};
|
|
10943
11529
|
/**
|
|
10944
|
-
*
|
|
10945
|
-
* @description
|
|
11530
|
+
* Get aggregated list of account counterparts found in transactions
|
|
11531
|
+
* @description Returns the aggregated list of account counterpats found in transactions. Useful for categorisation.
|
|
10946
11532
|
*/
|
|
10947
|
-
|
|
11533
|
+
banking_get_account_counterparts: {
|
|
10948
11534
|
parameters: {
|
|
11535
|
+
query?: {
|
|
11536
|
+
accountid?: string;
|
|
11537
|
+
date_from?: string;
|
|
11538
|
+
date_to?: string;
|
|
11539
|
+
page?: number;
|
|
11540
|
+
size?: number;
|
|
11541
|
+
};
|
|
10949
11542
|
path: {
|
|
10950
11543
|
consumer_id: string;
|
|
10951
11544
|
};
|
|
10952
11545
|
};
|
|
10953
|
-
requestBody: {
|
|
10954
|
-
content: {
|
|
10955
|
-
'application/json': components['schemas']['ContactItemIn'];
|
|
10956
|
-
};
|
|
10957
|
-
};
|
|
10958
11546
|
responses: {
|
|
10959
11547
|
/** @description Successful Response */
|
|
10960
11548
|
200: {
|
|
10961
11549
|
content: {
|
|
10962
|
-
'application/json': components['schemas']['
|
|
11550
|
+
'application/json': components['schemas']['Page_BankingCounterPartItem_'];
|
|
10963
11551
|
};
|
|
10964
11552
|
};
|
|
10965
11553
|
/** @description Bad Request */
|
|
@@ -10977,13 +11565,16 @@ export interface operations {
|
|
|
10977
11565
|
};
|
|
10978
11566
|
};
|
|
10979
11567
|
/**
|
|
10980
|
-
* Retrieve
|
|
10981
|
-
* @description Returns a
|
|
11568
|
+
* Retrieve all Balances
|
|
11569
|
+
* @description Returns a list of balances.
|
|
10982
11570
|
*/
|
|
10983
|
-
|
|
11571
|
+
payment_get_balances: {
|
|
10984
11572
|
parameters: {
|
|
11573
|
+
query?: {
|
|
11574
|
+
page?: number;
|
|
11575
|
+
size?: number;
|
|
11576
|
+
};
|
|
10985
11577
|
path: {
|
|
10986
|
-
contact_id: string;
|
|
10987
11578
|
consumer_id: string;
|
|
10988
11579
|
};
|
|
10989
11580
|
};
|
|
@@ -10991,7 +11582,7 @@ export interface operations {
|
|
|
10991
11582
|
/** @description Successful Response */
|
|
10992
11583
|
200: {
|
|
10993
11584
|
content: {
|
|
10994
|
-
'application/json': components['schemas']['
|
|
11585
|
+
'application/json': components['schemas']['ChiftPage_BalanceItemOut_'];
|
|
10995
11586
|
};
|
|
10996
11587
|
};
|
|
10997
11588
|
/** @description Bad Request */
|
|
@@ -11000,8 +11591,45 @@ export interface operations {
|
|
|
11000
11591
|
'application/json': components['schemas']['ChiftError'];
|
|
11001
11592
|
};
|
|
11002
11593
|
};
|
|
11003
|
-
/** @description
|
|
11004
|
-
|
|
11594
|
+
/** @description Validation Error */
|
|
11595
|
+
422: {
|
|
11596
|
+
content: {
|
|
11597
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
11598
|
+
};
|
|
11599
|
+
};
|
|
11600
|
+
};
|
|
11601
|
+
};
|
|
11602
|
+
/**
|
|
11603
|
+
* Retrieve all Transactions
|
|
11604
|
+
* @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
|
|
11605
|
+
*/
|
|
11606
|
+
payment_get_transaction: {
|
|
11607
|
+
parameters: {
|
|
11608
|
+
query?: {
|
|
11609
|
+
/** @description Filter based on the type of the transaction. */
|
|
11610
|
+
accounting_category?: components['schemas']['TransactionAccountingCategory'];
|
|
11611
|
+
/** @description Get all transactions more recent than this one excluded */
|
|
11612
|
+
starting_from?: string;
|
|
11613
|
+
/** @description Get all transactions for a specific balance */
|
|
11614
|
+
balance_id?: string;
|
|
11615
|
+
date_from?: string;
|
|
11616
|
+
date_to?: string;
|
|
11617
|
+
page?: number;
|
|
11618
|
+
size?: number;
|
|
11619
|
+
};
|
|
11620
|
+
path: {
|
|
11621
|
+
consumer_id: string;
|
|
11622
|
+
};
|
|
11623
|
+
};
|
|
11624
|
+
responses: {
|
|
11625
|
+
/** @description Successful Response */
|
|
11626
|
+
200: {
|
|
11627
|
+
content: {
|
|
11628
|
+
'application/json': components['schemas']['ChiftPage_TransactionItemOut_'];
|
|
11629
|
+
};
|
|
11630
|
+
};
|
|
11631
|
+
/** @description Bad Request */
|
|
11632
|
+
400: {
|
|
11005
11633
|
content: {
|
|
11006
11634
|
'application/json': components['schemas']['ChiftError'];
|
|
11007
11635
|
};
|
|
@@ -11015,12 +11643,16 @@ export interface operations {
|
|
|
11015
11643
|
};
|
|
11016
11644
|
};
|
|
11017
11645
|
/**
|
|
11018
|
-
* Get
|
|
11019
|
-
* @description Returns
|
|
11646
|
+
* Get orders (PMS)
|
|
11647
|
+
* @description Returns a list of the orders
|
|
11020
11648
|
*/
|
|
11021
|
-
|
|
11649
|
+
pms_get_orders: {
|
|
11022
11650
|
parameters: {
|
|
11023
|
-
query
|
|
11651
|
+
query: {
|
|
11652
|
+
date_from: string;
|
|
11653
|
+
date_to: string;
|
|
11654
|
+
location_id?: string;
|
|
11655
|
+
state?: components['schemas']['PMSStates'];
|
|
11024
11656
|
page?: number;
|
|
11025
11657
|
size?: number;
|
|
11026
11658
|
};
|
|
@@ -11032,7 +11664,7 @@ export interface operations {
|
|
|
11032
11664
|
/** @description Successful Response */
|
|
11033
11665
|
200: {
|
|
11034
11666
|
content: {
|
|
11035
|
-
'application/json': components['schemas']['
|
|
11667
|
+
'application/json': components['schemas']['ChiftPage_PMSOrderItem_'];
|
|
11036
11668
|
};
|
|
11037
11669
|
};
|
|
11038
11670
|
/** @description Bad Request */
|
|
@@ -11041,19 +11673,31 @@ export interface operations {
|
|
|
11041
11673
|
'application/json': components['schemas']['ChiftError'];
|
|
11042
11674
|
};
|
|
11043
11675
|
};
|
|
11676
|
+
/** @description Method Not Allowed */
|
|
11677
|
+
405: {
|
|
11678
|
+
content: {
|
|
11679
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11680
|
+
};
|
|
11681
|
+
};
|
|
11044
11682
|
/** @description Validation Error */
|
|
11045
11683
|
422: {
|
|
11046
11684
|
content: {
|
|
11047
11685
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11048
11686
|
};
|
|
11049
11687
|
};
|
|
11688
|
+
/** @description Bad Gateway */
|
|
11689
|
+
502: {
|
|
11690
|
+
content: {
|
|
11691
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11692
|
+
};
|
|
11693
|
+
};
|
|
11050
11694
|
};
|
|
11051
11695
|
};
|
|
11052
11696
|
/**
|
|
11053
|
-
* Get
|
|
11054
|
-
* @description Returns
|
|
11697
|
+
* Get locations (PMS)
|
|
11698
|
+
* @description Returns a list of the locations
|
|
11055
11699
|
*/
|
|
11056
|
-
|
|
11700
|
+
pms_get_locations: {
|
|
11057
11701
|
parameters: {
|
|
11058
11702
|
query?: {
|
|
11059
11703
|
page?: number;
|
|
@@ -11067,7 +11711,7 @@ export interface operations {
|
|
|
11067
11711
|
/** @description Successful Response */
|
|
11068
11712
|
200: {
|
|
11069
11713
|
content: {
|
|
11070
|
-
'application/json': components['schemas']['
|
|
11714
|
+
'application/json': components['schemas']['ChiftPage_PMSLocationItem_'];
|
|
11071
11715
|
};
|
|
11072
11716
|
};
|
|
11073
11717
|
/** @description Bad Request */
|
|
@@ -11076,37 +11720,47 @@ export interface operations {
|
|
|
11076
11720
|
'application/json': components['schemas']['ChiftError'];
|
|
11077
11721
|
};
|
|
11078
11722
|
};
|
|
11723
|
+
/** @description Method Not Allowed */
|
|
11724
|
+
405: {
|
|
11725
|
+
content: {
|
|
11726
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11727
|
+
};
|
|
11728
|
+
};
|
|
11079
11729
|
/** @description Validation Error */
|
|
11080
11730
|
422: {
|
|
11081
11731
|
content: {
|
|
11082
11732
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11083
11733
|
};
|
|
11084
11734
|
};
|
|
11735
|
+
/** @description Bad Gateway */
|
|
11736
|
+
502: {
|
|
11737
|
+
content: {
|
|
11738
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11739
|
+
};
|
|
11740
|
+
};
|
|
11085
11741
|
};
|
|
11086
11742
|
};
|
|
11087
11743
|
/**
|
|
11088
|
-
* Get
|
|
11089
|
-
* @description Returns
|
|
11744
|
+
* Get payments (PMS)
|
|
11745
|
+
* @description Returns a list of payments
|
|
11090
11746
|
*/
|
|
11091
|
-
|
|
11747
|
+
pms_get_payments: {
|
|
11092
11748
|
parameters: {
|
|
11093
|
-
query
|
|
11094
|
-
date_from
|
|
11095
|
-
date_to
|
|
11096
|
-
date_type?: components['schemas']['TransactionFilterDateType'];
|
|
11749
|
+
query: {
|
|
11750
|
+
date_from: string;
|
|
11751
|
+
date_to: string;
|
|
11097
11752
|
page?: number;
|
|
11098
11753
|
size?: number;
|
|
11099
11754
|
};
|
|
11100
11755
|
path: {
|
|
11101
11756
|
consumer_id: string;
|
|
11102
|
-
account_id: string;
|
|
11103
11757
|
};
|
|
11104
11758
|
};
|
|
11105
11759
|
responses: {
|
|
11106
11760
|
/** @description Successful Response */
|
|
11107
11761
|
200: {
|
|
11108
11762
|
content: {
|
|
11109
|
-
'application/json': components['schemas']['
|
|
11763
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentItem_'];
|
|
11110
11764
|
};
|
|
11111
11765
|
};
|
|
11112
11766
|
/** @description Bad Request */
|
|
@@ -11115,24 +11769,34 @@ export interface operations {
|
|
|
11115
11769
|
'application/json': components['schemas']['ChiftError'];
|
|
11116
11770
|
};
|
|
11117
11771
|
};
|
|
11772
|
+
/** @description Method Not Allowed */
|
|
11773
|
+
405: {
|
|
11774
|
+
content: {
|
|
11775
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11776
|
+
};
|
|
11777
|
+
};
|
|
11118
11778
|
/** @description Validation Error */
|
|
11119
11779
|
422: {
|
|
11120
11780
|
content: {
|
|
11121
11781
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11122
11782
|
};
|
|
11123
11783
|
};
|
|
11784
|
+
/** @description Bad Gateway */
|
|
11785
|
+
502: {
|
|
11786
|
+
content: {
|
|
11787
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11788
|
+
};
|
|
11789
|
+
};
|
|
11124
11790
|
};
|
|
11125
11791
|
};
|
|
11126
11792
|
/**
|
|
11127
|
-
* Get
|
|
11128
|
-
* @description Returns the
|
|
11793
|
+
* Get payment methods (PMS)
|
|
11794
|
+
* @description Returns the list of payment methods
|
|
11129
11795
|
*/
|
|
11130
|
-
|
|
11796
|
+
pms_get_payments_methods: {
|
|
11131
11797
|
parameters: {
|
|
11132
11798
|
query?: {
|
|
11133
|
-
|
|
11134
|
-
date_from?: string;
|
|
11135
|
-
date_to?: string;
|
|
11799
|
+
location_id?: string;
|
|
11136
11800
|
page?: number;
|
|
11137
11801
|
size?: number;
|
|
11138
11802
|
};
|
|
@@ -11144,7 +11808,7 @@ export interface operations {
|
|
|
11144
11808
|
/** @description Successful Response */
|
|
11145
11809
|
200: {
|
|
11146
11810
|
content: {
|
|
11147
|
-
'application/json': components['schemas']['
|
|
11811
|
+
'application/json': components['schemas']['ChiftPage_PMSPaymentMethods_'];
|
|
11148
11812
|
};
|
|
11149
11813
|
};
|
|
11150
11814
|
/** @description Bad Request */
|
|
@@ -11153,19 +11817,31 @@ export interface operations {
|
|
|
11153
11817
|
'application/json': components['schemas']['ChiftError'];
|
|
11154
11818
|
};
|
|
11155
11819
|
};
|
|
11820
|
+
/** @description Method Not Allowed */
|
|
11821
|
+
405: {
|
|
11822
|
+
content: {
|
|
11823
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11824
|
+
};
|
|
11825
|
+
};
|
|
11156
11826
|
/** @description Validation Error */
|
|
11157
11827
|
422: {
|
|
11158
11828
|
content: {
|
|
11159
11829
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11160
11830
|
};
|
|
11161
11831
|
};
|
|
11832
|
+
/** @description Bad Gateway */
|
|
11833
|
+
502: {
|
|
11834
|
+
content: {
|
|
11835
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11836
|
+
};
|
|
11837
|
+
};
|
|
11162
11838
|
};
|
|
11163
11839
|
};
|
|
11164
11840
|
/**
|
|
11165
|
-
*
|
|
11166
|
-
* @description Returns a list of
|
|
11841
|
+
* Get accounting categories (PMS)
|
|
11842
|
+
* @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
11843
|
*/
|
|
11168
|
-
|
|
11844
|
+
pms_get_accounting_categories: {
|
|
11169
11845
|
parameters: {
|
|
11170
11846
|
query?: {
|
|
11171
11847
|
page?: number;
|
|
@@ -11179,7 +11855,7 @@ export interface operations {
|
|
|
11179
11855
|
/** @description Successful Response */
|
|
11180
11856
|
200: {
|
|
11181
11857
|
content: {
|
|
11182
|
-
'application/json': components['schemas']['
|
|
11858
|
+
'application/json': components['schemas']['ChiftPage_PMSAccountingCategoryItem_'];
|
|
11183
11859
|
};
|
|
11184
11860
|
};
|
|
11185
11861
|
/** @description Bad Request */
|
|
@@ -11188,41 +11864,45 @@ export interface operations {
|
|
|
11188
11864
|
'application/json': components['schemas']['ChiftError'];
|
|
11189
11865
|
};
|
|
11190
11866
|
};
|
|
11867
|
+
/** @description Method Not Allowed */
|
|
11868
|
+
405: {
|
|
11869
|
+
content: {
|
|
11870
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11871
|
+
};
|
|
11872
|
+
};
|
|
11191
11873
|
/** @description Validation Error */
|
|
11192
11874
|
422: {
|
|
11193
11875
|
content: {
|
|
11194
11876
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11195
11877
|
};
|
|
11196
11878
|
};
|
|
11879
|
+
/** @description Bad Gateway */
|
|
11880
|
+
502: {
|
|
11881
|
+
content: {
|
|
11882
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11883
|
+
};
|
|
11884
|
+
};
|
|
11197
11885
|
};
|
|
11198
11886
|
};
|
|
11199
11887
|
/**
|
|
11200
|
-
*
|
|
11201
|
-
* @description Returns
|
|
11888
|
+
* Get closure info for a specific day (PMS)
|
|
11889
|
+
* @description Returns whether the closure was already done for a specific day or not
|
|
11202
11890
|
*/
|
|
11203
|
-
|
|
11891
|
+
pms_get_closure: {
|
|
11204
11892
|
parameters: {
|
|
11205
11893
|
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;
|
|
11894
|
+
location_id?: string;
|
|
11216
11895
|
};
|
|
11217
11896
|
path: {
|
|
11218
11897
|
consumer_id: string;
|
|
11898
|
+
date: string;
|
|
11219
11899
|
};
|
|
11220
11900
|
};
|
|
11221
11901
|
responses: {
|
|
11222
11902
|
/** @description Successful Response */
|
|
11223
11903
|
200: {
|
|
11224
11904
|
content: {
|
|
11225
|
-
'application/json': components['schemas']['
|
|
11905
|
+
'application/json': components['schemas']['PMSClosureItem'];
|
|
11226
11906
|
};
|
|
11227
11907
|
};
|
|
11228
11908
|
/** @description Bad Request */
|
|
@@ -11231,12 +11911,24 @@ export interface operations {
|
|
|
11231
11911
|
'application/json': components['schemas']['ChiftError'];
|
|
11232
11912
|
};
|
|
11233
11913
|
};
|
|
11914
|
+
/** @description Method Not Allowed */
|
|
11915
|
+
405: {
|
|
11916
|
+
content: {
|
|
11917
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11918
|
+
};
|
|
11919
|
+
};
|
|
11234
11920
|
/** @description Validation Error */
|
|
11235
11921
|
422: {
|
|
11236
11922
|
content: {
|
|
11237
11923
|
'application/json': components['schemas']['HTTPValidationError'];
|
|
11238
11924
|
};
|
|
11239
11925
|
};
|
|
11926
|
+
/** @description Bad Gateway */
|
|
11927
|
+
502: {
|
|
11928
|
+
content: {
|
|
11929
|
+
'application/json': components['schemas']['ChiftError'];
|
|
11930
|
+
};
|
|
11931
|
+
};
|
|
11240
11932
|
};
|
|
11241
11933
|
};
|
|
11242
11934
|
/**
|