@chift/chift-nodejs 1.0.22 → 1.0.23

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.
@@ -780,6 +780,26 @@ export interface paths {
780
780
  patch?: never;
781
781
  trace?: never;
782
782
  };
783
+ '/consumers/{consumer_id}/accounting/accounts': {
784
+ parameters: {
785
+ query?: never;
786
+ header?: never;
787
+ path?: never;
788
+ cookie?: never;
789
+ };
790
+ get?: never;
791
+ put?: never;
792
+ /**
793
+ * Create ledger account
794
+ * @description Create a new ledger account in the chart of accounts
795
+ */
796
+ post: operations['accounting_create_ledger_account'];
797
+ delete?: never;
798
+ options?: never;
799
+ head?: never;
800
+ patch?: never;
801
+ trace?: never;
802
+ };
783
803
  '/consumers/{consumer_id}/accounting/analytic-accounts': {
784
804
  parameters: {
785
805
  query?: never;
@@ -2284,6 +2304,26 @@ export interface paths {
2284
2304
  patch?: never;
2285
2305
  trace?: never;
2286
2306
  };
2307
+ '/consumers/{consumer_id}/pms/customers/{customer_id}': {
2308
+ parameters: {
2309
+ query?: never;
2310
+ header?: never;
2311
+ path?: never;
2312
+ cookie?: never;
2313
+ };
2314
+ /**
2315
+ * Get one customer (PMS)
2316
+ * @description Returns a specific customer
2317
+ */
2318
+ get: operations['pms_get_customer'];
2319
+ put?: never;
2320
+ post?: never;
2321
+ delete?: never;
2322
+ options?: never;
2323
+ head?: never;
2324
+ patch?: never;
2325
+ trace?: never;
2326
+ };
2287
2327
  '/consumers/{consumer_id}/pms/locations': {
2288
2328
  parameters: {
2289
2329
  query?: never;
@@ -2480,23 +2520,34 @@ export interface components {
2480
2520
  };
2481
2521
  /** AccountingCategoryItem */
2482
2522
  AccountingCategoryItem: {
2483
- /** Id */
2523
+ /**
2524
+ * Id
2525
+ * @description Unique identifier of the accounting category
2526
+ * @example 371ca583-d218-4900-b236-397532cf0e2
2527
+ */
2484
2528
  id: string;
2485
- /** Name */
2529
+ /**
2530
+ * Name
2531
+ * @description Name given to the accounting category
2532
+ * @example Beverages
2533
+ */
2486
2534
  name: string;
2487
2535
  /**
2488
2536
  * Code
2489
2537
  * @description Code assigned to the category
2538
+ * @example 123456
2490
2539
  */
2491
2540
  code?: string;
2492
2541
  /**
2493
2542
  * Ledger Account Code
2494
2543
  * @description Ledger account code assigned to the category
2544
+ * @example 123456
2495
2545
  */
2496
2546
  ledger_account_code?: string;
2497
2547
  /**
2498
2548
  * Posting Account Code
2499
2549
  * @description Posting account code assigned to the category
2550
+ * @example 123456
2500
2551
  */
2501
2552
  posting_account_code?: string;
2502
2553
  };
@@ -2520,21 +2571,53 @@ export interface components {
2520
2571
  };
2521
2572
  /** AddressItem */
2522
2573
  AddressItem: {
2523
- /** Address Type */
2574
+ /**
2575
+ * Address Type
2576
+ * @description Type of the address
2577
+ * @example home
2578
+ */
2524
2579
  address_type?: string;
2525
- /** Name */
2580
+ /**
2581
+ * Name
2582
+ * @description Name given to the address (e.g. 'home')
2583
+ * @example Home
2584
+ */
2526
2585
  name?: string;
2527
- /** Street */
2586
+ /**
2587
+ * Street
2588
+ * @description Street name
2589
+ * @example Main Street
2590
+ */
2528
2591
  street?: string;
2529
- /** Number */
2592
+ /**
2593
+ * Number
2594
+ * @description Number of the address
2595
+ * @example 123
2596
+ */
2530
2597
  number?: string;
2531
- /** Box */
2598
+ /**
2599
+ * Box
2600
+ * @description Box of the address
2601
+ * @example A
2602
+ */
2532
2603
  box?: string;
2533
- /** City */
2604
+ /**
2605
+ * City
2606
+ * @description City name
2607
+ * @example Paris
2608
+ */
2534
2609
  city?: string;
2535
- /** Postal Code */
2610
+ /**
2611
+ * Postal Code
2612
+ * @description Postal code of the address
2613
+ * @example 75000
2614
+ */
2536
2615
  postal_code?: string;
2537
- /** Country */
2616
+ /**
2617
+ * Country
2618
+ * @description Country, format: ISO 3166-1 codes.
2619
+ * @example FR
2620
+ */
2538
2621
  country?: string;
2539
2622
  };
2540
2623
  /** AddressItemInInvoicing */
@@ -2805,84 +2888,186 @@ export interface components {
2805
2888
  };
2806
2889
  /** BankingAccountItem */
2807
2890
  BankingAccountItem: {
2808
- /** Id */
2891
+ /**
2892
+ * Id
2893
+ * @description Unique identifier of the account
2894
+ * @example account-123
2895
+ */
2809
2896
  id: string;
2810
- /** Currency */
2897
+ /**
2898
+ * Currency
2899
+ * @description Currency of the account
2900
+ * @example EUR
2901
+ */
2811
2902
  currency: string;
2812
- /** Current Balance */
2903
+ /**
2904
+ * Current Balance
2905
+ * @description Current balance of the account
2906
+ * @example 1000
2907
+ */
2813
2908
  current_balance: number;
2814
2909
  /**
2815
2910
  * Current Balance Last Update Date
2816
2911
  * Format: date-time
2912
+ * @description Last update date of the current balance
2913
+ * @example 2025-01-01T00:00:00Z
2817
2914
  */
2818
2915
  current_balance_last_update_date?: string;
2819
- /** Available Balance */
2916
+ /**
2917
+ * Available Balance
2918
+ * @description Available balance of the account
2919
+ * @example 1000
2920
+ */
2820
2921
  available_balance: number;
2821
2922
  /**
2822
2923
  * Available Balance Last Update Date
2823
2924
  * Format: date-time
2925
+ * @description Last update date of the available balance
2926
+ * @example 2025-01-01T00:00:00Z
2824
2927
  */
2825
2928
  available_balance_last_update_date?: string;
2826
- /** Description */
2929
+ /**
2930
+ * Description
2931
+ * @description Description of the account
2932
+ * @example Chift account
2933
+ */
2827
2934
  description: string;
2828
- /** Reference */
2935
+ /**
2936
+ * Reference
2937
+ * @description Reference of the account
2938
+ * @example FR76300040123456789012345678
2939
+ */
2829
2940
  reference: string;
2830
- /** Reference Type */
2941
+ /**
2942
+ * Reference Type
2943
+ * @description Type of the reference
2944
+ * @example IBAN
2945
+ */
2831
2946
  reference_type: string;
2832
- /** Holder Name */
2947
+ /**
2948
+ * Holder Name
2949
+ * @description Name of the account holder
2950
+ * @example John Doe
2951
+ */
2833
2952
  holder_name?: string;
2834
2953
  };
2835
2954
  /** BankingCounterPartItem */
2836
2955
  BankingCounterPartItem: {
2837
- /** Name */
2956
+ /**
2957
+ * Name
2958
+ * @description Name of the counterpart
2959
+ * @example John Doe
2960
+ */
2838
2961
  name?: string;
2839
- /** Reference */
2962
+ /**
2963
+ * Reference
2964
+ * @description Reference of the counterpart
2965
+ * @example FR76300040123456789012345678
2966
+ */
2840
2967
  reference?: string;
2841
- /** Details */
2968
+ /**
2969
+ * Details
2970
+ * @description Details of the counterpart
2971
+ * @example Chift counterpart
2972
+ */
2842
2973
  details?: string;
2843
2974
  };
2844
2975
  /** BankingFinancialInstitutionItem */
2845
2976
  BankingFinancialInstitutionItem: {
2846
- /** Id */
2977
+ /**
2978
+ * Id
2979
+ * @description Unique identifier of the financial institution
2980
+ * @example financial-institution-123
2981
+ */
2847
2982
  id: string;
2848
- /** Bic */
2983
+ /**
2984
+ * Bic
2985
+ * @description BIC of the financial institution
2986
+ * @example GEBABEBBXXX
2987
+ */
2849
2988
  bic?: string;
2850
- /** Country */
2989
+ /**
2990
+ * Country
2991
+ * @description Country of the financial institution, format: ISO 3166-1 codes.
2992
+ * @example FR
2993
+ */
2851
2994
  country?: string;
2852
- /** Name */
2995
+ /**
2996
+ * Name
2997
+ * @description Name of the financial institution
2998
+ * @example BNP
2999
+ */
2853
3000
  name: string;
2854
3001
  };
2855
3002
  /** BankingTransactionItem */
2856
3003
  BankingTransactionItem: {
2857
- /** Id */
3004
+ /**
3005
+ * Id
3006
+ * @description Unique identifier of the transaction
3007
+ * @example transaction-123
3008
+ */
2858
3009
  id: string;
2859
- /** Amount */
3010
+ /**
3011
+ * Amount
3012
+ * @description Amount of the transaction
3013
+ * @example 1000
3014
+ */
2860
3015
  amount: number;
2861
- /** Currency */
3016
+ /**
3017
+ * Currency
3018
+ * @description Currency of the transaction
3019
+ * @example EUR
3020
+ */
2862
3021
  currency: string;
2863
- /** Description */
3022
+ /**
3023
+ * Description
3024
+ * @description Description of the transaction
3025
+ * @example Chift transaction
3026
+ */
2864
3027
  description?: string;
2865
- /** Additional Information */
3028
+ /**
3029
+ * Additional Information
3030
+ * @description Additional information of the transaction
3031
+ * @example Chift transaction
3032
+ */
2866
3033
  additional_information?: string;
2867
- /** Counterpart Name */
3034
+ /**
3035
+ * Counterpart Name
3036
+ * @description Name of the counterpart
3037
+ * @example John Doe
3038
+ */
2868
3039
  counterpart_name?: string;
2869
- /** Counterpart Reference */
3040
+ /**
3041
+ * Counterpart Reference
3042
+ * @description Reference of the counterpart
3043
+ * @example FR76300040123456789012345678
3044
+ */
2870
3045
  counterpart_reference?: string;
2871
- /** Remittance Information */
3046
+ /**
3047
+ * Remittance Information
3048
+ * @description Remittance information of the transaction
3049
+ * @example Chift transaction
3050
+ */
2872
3051
  remittance_information?: string;
2873
3052
  /**
2874
3053
  * Creation Date
2875
3054
  * Format: date-time
3055
+ * @description Creation date of the transaction
3056
+ * @example 2025-01-01T00:00:00Z
2876
3057
  */
2877
3058
  creation_date: string;
2878
3059
  /**
2879
3060
  * Value Date
2880
3061
  * Format: date-time
3062
+ * @description Value date of the transaction
3063
+ * @example 2025-01-01T00:00:00Z
2881
3064
  */
2882
3065
  value_date: string;
2883
3066
  /**
2884
3067
  * Execution Date
2885
3068
  * Format: date-time
3069
+ * @description Execution date of the transaction
3070
+ * @example 2025-01-01T00:00:00Z
2886
3071
  */
2887
3072
  execution_date: string;
2888
3073
  };
@@ -3836,8 +4021,14 @@ export interface components {
3836
4021
  /**
3837
4022
  * Date
3838
4023
  * Format: date
4024
+ * @description Date of the closure
4025
+ * @example 2025-01-01
3839
4026
  */
3840
4027
  date: string;
4028
+ /**
4029
+ * @description Status of the closure
4030
+ * @example closed
4031
+ */
3841
4032
  status: components['schemas']['ClosureStates'];
3842
4033
  };
3843
4034
  /**
@@ -5692,13 +5883,27 @@ export interface components {
5692
5883
  * @description Technical id in the target software
5693
5884
  */
5694
5885
  source_ref: components['schemas']['Ref'];
5886
+ /** @description Type of the partner */
5695
5887
  type: components['schemas']['PartnerType'];
5888
+ /**
5889
+ * Address
5890
+ * @description Address of the partner
5891
+ */
5696
5892
  address?: components['schemas']['AddressItem'];
5697
- /** First Name */
5893
+ /**
5894
+ * First Name
5895
+ * @description First name of the partner. In case the partner is an individual.
5896
+ */
5698
5897
  first_name?: string;
5699
- /** Last Name */
5898
+ /**
5899
+ * Last Name
5900
+ * @description Last name of the partner. In case the partner is an individual.
5901
+ */
5700
5902
  last_name?: string;
5701
- /** Company Name */
5903
+ /**
5904
+ * Company Name
5905
+ * @description Company name of the partner. In case the partner is a company.
5906
+ */
5702
5907
  company_name?: string;
5703
5908
  };
5704
5909
  /**
@@ -6078,6 +6283,13 @@ export interface components {
6078
6283
  | 'financial_operation'
6079
6284
  | 'miscellaneous_operation'
6080
6285
  | 'unknown';
6286
+ /** LedgerAccountItemIn */
6287
+ LedgerAccountItemIn: {
6288
+ /** Name */
6289
+ name: string;
6290
+ /** Number */
6291
+ number: string;
6292
+ };
6081
6293
  /** LinkItem */
6082
6294
  LinkItem: {
6083
6295
  /** Url */
@@ -6857,28 +7069,39 @@ export interface components {
6857
7069
  OutstandingType: 'client' | 'supplier';
6858
7070
  /** PMSAccountingCategoryItem */
6859
7071
  PMSAccountingCategoryItem: {
6860
- /** Id */
7072
+ /**
7073
+ * Id
7074
+ * @description Unique identifier of the accounting category
7075
+ * @example 371ca583-d218-4900-b236-397532cf0e2
7076
+ */
6861
7077
  id: string;
6862
7078
  /**
6863
7079
  * Source Ref
6864
7080
  * @description Technical id in the target software
6865
7081
  */
6866
7082
  source_ref: components['schemas']['Ref'];
6867
- /** Name */
7083
+ /**
7084
+ * Name
7085
+ * @description Name given to the accounting category
7086
+ * @example Beverages
7087
+ */
6868
7088
  name: string;
6869
7089
  /**
6870
7090
  * Code
6871
7091
  * @description Code assigned to the category
7092
+ * @example 123456
6872
7093
  */
6873
7094
  code?: string;
6874
7095
  /**
6875
7096
  * Ledger Account Code
6876
7097
  * @description Ledger account code assigned to the category
7098
+ * @example 123456
6877
7099
  */
6878
7100
  ledger_account_code?: string;
6879
7101
  /**
6880
7102
  * Posting Account Code
6881
7103
  * @description Posting account code assigned to the category
7104
+ * @example 123456
6882
7105
  */
6883
7106
  posting_account_code?: string;
6884
7107
  };
@@ -6887,8 +7110,14 @@ export interface components {
6887
7110
  /**
6888
7111
  * Date
6889
7112
  * Format: date
7113
+ * @description Date of the closure
7114
+ * @example 2025-01-01
6890
7115
  */
6891
7116
  date: string;
7117
+ /**
7118
+ * @description Status of the closure
7119
+ * @example closed
7120
+ */
6892
7121
  status: components['schemas']['ClosureStates'];
6893
7122
  };
6894
7123
  /** PMSCustomerItem */
@@ -6903,15 +7132,30 @@ export interface components {
6903
7132
  * @description Technical id in the target software
6904
7133
  */
6905
7134
  source_ref: components['schemas']['Ref'];
6906
- /** First Name */
7135
+ /**
7136
+ * First Name
7137
+ * @description First name of the customer. In case the customer is an individual.
7138
+ */
6907
7139
  first_name?: string;
6908
- /** Last Name */
7140
+ /**
7141
+ * Last Name
7142
+ * @description Last name of the customer. In case the customer is an individual.
7143
+ */
6909
7144
  last_name?: string;
6910
- /** Company Name */
7145
+ /**
7146
+ * Company Name
7147
+ * @description Company name of the customer. In case the customer is a company.
7148
+ */
6911
7149
  company_name?: string;
6912
- /** Phone */
7150
+ /**
7151
+ * Phone
7152
+ * @description Phone number of the customer
7153
+ */
6913
7154
  phone?: string;
6914
- /** Email */
7155
+ /**
7156
+ * Email
7157
+ * @description Email address of the customer
7158
+ */
6915
7159
  email?: string;
6916
7160
  /**
6917
7161
  * Account Number
@@ -6921,9 +7165,13 @@ export interface components {
6921
7165
  /**
6922
7166
  * Created On
6923
7167
  * Format: date-time
7168
+ * @description Creation date of the customer
6924
7169
  */
6925
7170
  created_on?: string;
6926
- /** Addresses */
7171
+ /**
7172
+ * Addresses
7173
+ * @description List of addresses related to the customer
7174
+ */
6927
7175
  addresses?: components['schemas']['AddressItem'][];
6928
7176
  };
6929
7177
  /** PMSInvoiceFullItem */
@@ -6946,18 +7194,29 @@ export interface components {
6946
7194
  /**
6947
7195
  * Creation Date
6948
7196
  * Format: date-time
7197
+ * @description Creation date of the invoice
6949
7198
  */
6950
7199
  creation_date?: string;
6951
7200
  /**
6952
7201
  * Closing Date
6953
7202
  * Format: date-time
7203
+ * @description Closing date of the invoice
6954
7204
  */
6955
7205
  closing_date?: string;
6956
- /** Partners */
7206
+ /**
7207
+ * Partners
7208
+ * @description List of partners related to the invoice
7209
+ */
6957
7210
  partners?: components['schemas']['InvoicePartnerItem'][];
6958
- /** Items */
7211
+ /**
7212
+ * Items
7213
+ * @description List of items related to the invoice
7214
+ */
6959
7215
  items: components['schemas']['PMSOrderLineItem'][];
6960
- /** Payments */
7216
+ /**
7217
+ * Payments
7218
+ * @description List of payments related to the invoice
7219
+ */
6961
7220
  payments: components['schemas']['PMSPaymentItem'][];
6962
7221
  /**
6963
7222
  * Service Id
@@ -6972,88 +7231,162 @@ export interface components {
6972
7231
  };
6973
7232
  /** PMSLocationItem */
6974
7233
  PMSLocationItem: {
6975
- /** Id */
7234
+ /**
7235
+ * Id
7236
+ * @description Unique identifier of the location
7237
+ * @example 371ca583-d218-4900-b236-397532cf0e52
7238
+ */
6976
7239
  id: string;
6977
- /** Name */
7240
+ /**
7241
+ * Name
7242
+ * @description Name given to the location
7243
+ * @example Restaurant de la Paix
7244
+ */
6978
7245
  name: string;
6979
7246
  /**
6980
7247
  * Timezone
6981
7248
  * @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
7249
+ * @example Europe/Paris
6982
7250
  */
6983
7251
  timezone?: string;
7252
+ /**
7253
+ * Address
7254
+ * @description Address of the location
7255
+ */
6984
7256
  address?: components['schemas']['AddressItem'];
6985
7257
  };
6986
7258
  /** PMSOrderItem */
6987
7259
  PMSOrderItem: {
6988
- /** Id */
7260
+ /**
7261
+ * Id
7262
+ * @description Unique identifier of the order
7263
+ * @example 123
7264
+ */
6989
7265
  id: string;
6990
7266
  /**
6991
7267
  * Source Ref
6992
7268
  * @description Technical id in the target software
6993
7269
  */
6994
7270
  source_ref: components['schemas']['Ref'];
6995
- /** Order Number */
7271
+ /**
7272
+ * Order Number
7273
+ * @description Order number (often unique reference during the day)
7274
+ * @example 1
7275
+ */
6996
7276
  order_number?: string;
6997
7277
  /**
6998
7278
  * Creation Date
6999
7279
  * Format: date-time
7280
+ * @description Creation date of the order
7281
+ * @example 2025-01-01T00:00:00Z
7000
7282
  */
7001
7283
  creation_date: string;
7002
7284
  /**
7003
7285
  * Closing Date
7004
7286
  * Format: date-time
7287
+ * @description Closing date of the order
7288
+ * @example 2025-01-01T00:00:00Z
7005
7289
  */
7006
7290
  closing_date?: string;
7007
7291
  /**
7008
7292
  * Service Date
7009
7293
  * Format: date-time
7010
7294
  * @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
7295
+ * @example 2025-01-01T00:00:00Z
7011
7296
  */
7012
7297
  service_date?: string;
7013
7298
  /**
7014
7299
  * Device Id
7015
7300
  * @description ID of device that created the order
7301
+ * @example device-123
7016
7302
  */
7017
7303
  device_id?: string;
7018
- /** Total */
7304
+ /**
7305
+ * Total
7306
+ * @description Total amount including tax of the order
7307
+ * @example 11
7308
+ */
7019
7309
  total: number;
7020
- /** Tax Amount */
7310
+ /**
7311
+ * Tax Amount
7312
+ * @description Total amount of the taxes of the order
7313
+ * @example 1
7314
+ */
7021
7315
  tax_amount: number;
7022
7316
  /**
7023
7317
  * Total Discount
7318
+ * @description Total amount of the discounts of the order
7024
7319
  * @default 0
7320
+ * @example 10
7025
7321
  */
7026
7322
  total_discount: number;
7027
7323
  /**
7028
7324
  * Total Refund
7325
+ * @description Total amount of the refunds of the order
7029
7326
  * @default 0
7327
+ * @example 5
7030
7328
  */
7031
7329
  total_refund: number;
7032
7330
  /**
7033
7331
  * Total Tip
7332
+ * @description Total amount of the tips of the order. Tips are not part of the total of the order
7034
7333
  * @default 0
7334
+ * @example 1
7035
7335
  */
7036
7336
  total_tip: number;
7037
7337
  /**
7038
7338
  * Delivery Fee
7339
+ * @description Total amount of the delivery fees of the order
7039
7340
  * @default 0
7341
+ * @example 1
7040
7342
  */
7041
7343
  delivery_fee: number;
7042
- /** Currency */
7344
+ /**
7345
+ * Currency
7346
+ * @description Currency of the order
7347
+ * @example EUR
7348
+ */
7043
7349
  currency?: string;
7044
- /** Country */
7350
+ /**
7351
+ * Country
7352
+ * @description Country of the order, format: ISO 3166-1 codes.
7353
+ * @example FR
7354
+ */
7045
7355
  country?: string;
7046
- /** Loyalty */
7356
+ /**
7357
+ * Loyalty
7358
+ * @description Loyalty points of the order
7359
+ * @example 100
7360
+ */
7047
7361
  loyalty?: number;
7048
- /** Customer Id */
7362
+ /**
7363
+ * Customer Id
7364
+ * @description Unique identifier of the customer
7365
+ * @example customer-123
7366
+ */
7049
7367
  customer_id?: string;
7050
- /** Location Id */
7368
+ /**
7369
+ * Location Id
7370
+ * @description Unique identifier of the location
7371
+ * @example location-123
7372
+ */
7051
7373
  location_id?: string;
7052
- /** Taxes */
7053
- taxes?: components['schemas']['TotalTaxItem'][];
7054
- /** Guests */
7374
+ /**
7375
+ * Taxes
7376
+ * @description List of taxes of the order
7377
+ * @default []
7378
+ */
7379
+ taxes: components['schemas']['TotalTaxItem'][];
7380
+ /**
7381
+ * Guests
7382
+ * @description Number of guests linked to the order
7383
+ * @example 1
7384
+ */
7055
7385
  guests?: number;
7056
- /** Items */
7386
+ /**
7387
+ * Items
7388
+ * @description List of items related to the order
7389
+ */
7057
7390
  items: components['schemas']['PMSOrderLineItem'][];
7058
7391
  /**
7059
7392
  * Service Id
@@ -7073,71 +7406,139 @@ export interface components {
7073
7406
  };
7074
7407
  /** PMSOrderLineItem */
7075
7408
  PMSOrderLineItem: {
7076
- /** Id */
7409
+ /**
7410
+ * Id
7411
+ * @description Unique identifier of the order line item
7412
+ * @example 123
7413
+ */
7077
7414
  id: string;
7078
7415
  /**
7079
7416
  * Source Ref
7080
7417
  * @description Technical id in the target software
7081
7418
  */
7082
7419
  source_ref: components['schemas']['Ref'];
7420
+ /**
7421
+ * @description Type of the order line item
7422
+ * @example product
7423
+ */
7083
7424
  type?: components['schemas']['POSLineItemType'];
7084
- /** Menu Id */
7425
+ /**
7426
+ * Menu Id
7427
+ * @description Unique identifier of the menu
7428
+ * @example 456
7429
+ */
7085
7430
  menu_id?: string;
7086
- /** Quantity */
7431
+ /**
7432
+ * Quantity
7433
+ * @description Quantity of the order line item
7434
+ * @example 1
7435
+ */
7087
7436
  quantity: number;
7088
- /** Unit Price */
7437
+ /**
7438
+ * Unit Price
7439
+ * @description Unit price (without tax) of the order line item
7440
+ * @example 10
7441
+ */
7089
7442
  unit_price: number;
7090
- /** Total */
7443
+ /**
7444
+ * Total
7445
+ * @description Total amount including tax of the order line item
7446
+ * @example 11
7447
+ */
7091
7448
  total: number;
7092
- /** Tax Amount */
7449
+ /**
7450
+ * Tax Amount
7451
+ * @description Total amount of the taxes of the order line item
7452
+ * @example 1
7453
+ */
7093
7454
  tax_amount: number;
7094
- /** Tax Rate */
7455
+ /**
7456
+ * Tax Rate
7457
+ * @description Tax rate of the order line item
7458
+ * @example 10
7459
+ */
7095
7460
  tax_rate?: number;
7096
- /** Description */
7461
+ /**
7462
+ * Description
7463
+ * @description Description of the order line item
7464
+ * @example Pizza
7465
+ */
7097
7466
  description?: string;
7098
7467
  /**
7099
7468
  * Discounts
7469
+ * @description List of discounts of the order line item. Discounts of items are always part of the total discount of the order
7100
7470
  * @default []
7471
+ * @example []
7101
7472
  */
7102
7473
  discounts: components['schemas']['backbone_common__models__pos_pms__DiscountItem'][];
7103
7474
  /**
7104
7475
  * Product Id
7105
7476
  * @description Reference to the product related to this item
7477
+ * @example 789
7106
7478
  */
7107
7479
  product_id?: string;
7108
7480
  /**
7109
7481
  * Accounting Category Id
7110
7482
  * @description Sometimes used by a POS to give a specific accounting category to an order item
7483
+ * @example 123
7111
7484
  */
7112
7485
  accounting_category_id?: string;
7113
7486
  };
7114
7487
  /** PMSPaymentItem */
7115
7488
  PMSPaymentItem: {
7116
- /** Id */
7489
+ /**
7490
+ * Id
7491
+ * @description Unique identifier of the payment
7492
+ * @example payment-123
7493
+ */
7117
7494
  id?: string;
7118
7495
  /**
7119
7496
  * Source Ref
7120
7497
  * @description Technical id in the target software
7121
7498
  */
7122
7499
  source_ref: components['schemas']['Ref'];
7123
- /** Payment Method Id */
7500
+ /**
7501
+ * Payment Method Id
7502
+ * @description Unique identifier of the payment method used for the payment
7503
+ * @example payment-method-123
7504
+ */
7124
7505
  payment_method_id?: string;
7125
- /** Payment Method Name */
7506
+ /**
7507
+ * Payment Method Name
7508
+ * @description Chift's name of the payment method used for the payment
7509
+ * @example Cash
7510
+ */
7126
7511
  payment_method_name?: string;
7127
- /** Total */
7512
+ /**
7513
+ * Total
7514
+ * @description Total amount of the payment
7515
+ * @example 11
7516
+ */
7128
7517
  total: number;
7129
7518
  /**
7130
7519
  * Tip
7520
+ * @description Total amount of the tips of the payment. Tips are not part of the total of the payment
7131
7521
  * @default 0
7522
+ * @example 1
7132
7523
  */
7133
7524
  tip: number;
7134
- /** @default Unknown */
7525
+ /**
7526
+ * @description Status of the payment
7527
+ * @default Unknown
7528
+ * @example Completed
7529
+ */
7135
7530
  status: components['schemas']['backbone_common__models__pos_pms__PaymentStatus'];
7136
- /** Currency */
7531
+ /**
7532
+ * Currency
7533
+ * @description Currency of the payment
7534
+ * @example EUR
7535
+ */
7137
7536
  currency?: string;
7138
7537
  /**
7139
7538
  * Date
7140
7539
  * Format: date-time
7540
+ * @description Date of the payment
7541
+ * @example 2025-01-01T00:00:00Z
7141
7542
  */
7142
7543
  date?: string;
7143
7544
  /**
@@ -7148,16 +7549,28 @@ export interface components {
7148
7549
  };
7149
7550
  /** PMSPaymentMethods */
7150
7551
  PMSPaymentMethods: {
7151
- /** Id */
7552
+ /**
7553
+ * Id
7554
+ * @description Unique identifier of the payment method
7555
+ * @example 371ca583-d218-4900-b236-397532cf0e52
7556
+ */
7152
7557
  id: string;
7153
7558
  /**
7154
7559
  * Source Ref
7155
7560
  * @description Technical id in the target software
7156
7561
  */
7157
7562
  source_ref: components['schemas']['Ref'];
7158
- /** Name */
7563
+ /**
7564
+ * Name
7565
+ * @description Chift's name of the payment method (e.g. 'Cash', 'Card', 'Transfer', ...)
7566
+ * @example Cash
7567
+ */
7159
7568
  name: string;
7160
- /** Extra */
7569
+ /**
7570
+ * Extra
7571
+ * @description Original name of the payment method
7572
+ * @example Espèces
7573
+ */
7161
7574
  extra?: string;
7162
7575
  /**
7163
7576
  * Ledger Account Code
@@ -7173,78 +7586,173 @@ export interface components {
7173
7586
  PMSStates: 'consumed' | 'closed';
7174
7587
  /** POSCreateCustomerItem */
7175
7588
  POSCreateCustomerItem: {
7176
- /** First Name */
7589
+ /**
7590
+ * First Name
7591
+ * @description First name of the customer
7592
+ * @example John
7593
+ */
7177
7594
  first_name: string;
7178
- /** Last Name */
7595
+ /**
7596
+ * Last Name
7597
+ * @description Last name of the customer
7598
+ * @example Doe
7599
+ */
7179
7600
  last_name: string;
7180
- /** Phone */
7601
+ /**
7602
+ * Phone
7603
+ * @description Phone number (mobile, home, work, ...) of the customer
7604
+ * @example +32475123456
7605
+ */
7181
7606
  phone?: string;
7182
- /** Email */
7607
+ /**
7608
+ * Email
7609
+ * @description Email address of the customer
7610
+ * @example john.doe@gmail.com
7611
+ */
7183
7612
  email?: string;
7613
+ /**
7614
+ * Address
7615
+ * @description Address of the customer
7616
+ */
7184
7617
  address?: components['schemas']['PostAddressItem'];
7185
7618
  };
7186
7619
  /** POSCustomerItem */
7187
7620
  POSCustomerItem: {
7188
- /** Id */
7621
+ /**
7622
+ * Id
7623
+ * @description Unique identifier of the customer
7624
+ * @example 371ca583-d218-8000-b236-397532cf0e52
7625
+ */
7189
7626
  id: string;
7190
- /** First Name */
7627
+ /**
7628
+ * First Name
7629
+ * @description First name of the customer
7630
+ * @example John
7631
+ */
7191
7632
  first_name?: string;
7192
- /** Last Name */
7633
+ /**
7634
+ * Last Name
7635
+ * @description Last name of the customer
7636
+ * @example Doe
7637
+ */
7193
7638
  last_name?: string;
7194
- /** Name */
7639
+ /**
7640
+ * Name
7641
+ * @description Name (first name + last name) of the customer
7642
+ * @example John Doe
7643
+ */
7195
7644
  name: string;
7196
- /** Phone */
7645
+ /**
7646
+ * Phone
7647
+ * @description Phone number (mobile, home, work, ...) of the customer
7648
+ * @example +32475123456
7649
+ */
7197
7650
  phone?: string;
7198
- /** Email */
7651
+ /**
7652
+ * Email
7653
+ * @description Email address of the customer
7654
+ * @example john.doe@gmail.com
7655
+ */
7199
7656
  email?: string;
7200
7657
  /**
7201
7658
  * Created On
7202
7659
  * Format: date-time
7660
+ * @description Date and time when the customer was created
7661
+ * @example 2025-01-01T00:00:00Z
7203
7662
  */
7204
7663
  created_on?: string;
7205
- /** Addresses */
7206
- addresses?: components['schemas']['AddressItem'][];
7207
- /** Loyalty */
7664
+ /**
7665
+ * Addresses
7666
+ * @description List of addresses of the customer
7667
+ * @default []
7668
+ */
7669
+ addresses: components['schemas']['AddressItem'][];
7670
+ /**
7671
+ * Loyalty
7672
+ * @description Loyalty points of the customer
7673
+ * @example 100
7674
+ */
7208
7675
  loyalty?: number;
7209
7676
  /**
7210
7677
  * Birthdate
7211
7678
  * Format: date
7212
- * @description Birthdate
7679
+ * @description Birthdate of the customer
7680
+ * @example 1990-01-01
7213
7681
  */
7214
7682
  birthdate?: string;
7215
7683
  };
7216
7684
  /** POSItem */
7217
7685
  POSItem: {
7218
- /** Id */
7686
+ /**
7687
+ * Id
7688
+ * @description Unique identifier of the order line item
7689
+ * @example 123
7690
+ */
7219
7691
  id: string;
7692
+ /**
7693
+ * @description Type of the order line item
7694
+ * @example product
7695
+ */
7220
7696
  type?: components['schemas']['POSLineItemType'];
7221
- /** Menu Id */
7697
+ /**
7698
+ * Menu Id
7699
+ * @description Unique identifier of the menu
7700
+ * @example 456
7701
+ */
7222
7702
  menu_id?: string;
7223
- /** Quantity */
7703
+ /**
7704
+ * Quantity
7705
+ * @description Quantity of the order line item
7706
+ * @example 1
7707
+ */
7224
7708
  quantity: number;
7225
- /** Unit Price */
7709
+ /**
7710
+ * Unit Price
7711
+ * @description Unit price (without tax) of the order line item
7712
+ * @example 10
7713
+ */
7226
7714
  unit_price: number;
7227
- /** Total */
7715
+ /**
7716
+ * Total
7717
+ * @description Total amount including tax of the order line item
7718
+ * @example 11
7719
+ */
7228
7720
  total: number;
7229
- /** Tax Amount */
7721
+ /**
7722
+ * Tax Amount
7723
+ * @description Total amount of the taxes of the order line item
7724
+ * @example 1
7725
+ */
7230
7726
  tax_amount: number;
7231
- /** Tax Rate */
7727
+ /**
7728
+ * Tax Rate
7729
+ * @description Tax rate of the order line item
7730
+ * @example 10
7731
+ */
7232
7732
  tax_rate?: number;
7233
- /** Description */
7733
+ /**
7734
+ * Description
7735
+ * @description Description of the order line item
7736
+ * @example Pizza
7737
+ */
7234
7738
  description?: string;
7235
7739
  /**
7236
7740
  * Discounts
7741
+ * @description List of discounts of the order line item. Discounts of items are always part of the total discount of the order
7237
7742
  * @default []
7743
+ * @example []
7238
7744
  */
7239
7745
  discounts: components['schemas']['backbone_common__models__pos_pms__DiscountItem'][];
7240
7746
  /**
7241
7747
  * Product Id
7242
7748
  * @description Reference to the product related to this item
7749
+ * @example 789
7243
7750
  */
7244
7751
  product_id?: string;
7245
7752
  /**
7246
7753
  * Accounting Category Id
7247
7754
  * @description Sometimes used by a POS to give a specific accounting category to an order item
7755
+ * @example 123
7248
7756
  */
7249
7757
  accounting_category_id?: string;
7250
7758
  };
@@ -7256,130 +7764,253 @@ export interface components {
7256
7764
  POSLineItemType: 'menu' | 'product';
7257
7765
  /** POSLocationItem */
7258
7766
  POSLocationItem: {
7259
- /** Id */
7767
+ /**
7768
+ * Id
7769
+ * @description Unique identifier of the location
7770
+ * @example 371ca583-d218-4900-b236-397532cf0e52
7771
+ */
7260
7772
  id: string;
7261
- /** Name */
7773
+ /**
7774
+ * Name
7775
+ * @description Name given to the location
7776
+ * @example Restaurant de la Paix
7777
+ */
7262
7778
  name: string;
7263
7779
  /**
7264
7780
  * Timezone
7265
7781
  * @description Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .
7782
+ * @example Europe/Paris
7266
7783
  */
7267
7784
  timezone?: string;
7785
+ /**
7786
+ * Address
7787
+ * @description Address of the location
7788
+ */
7268
7789
  address?: components['schemas']['AddressItem'];
7269
7790
  };
7270
7791
  /** POSOrderItem */
7271
7792
  POSOrderItem: {
7272
- /** Id */
7793
+ /**
7794
+ * Id
7795
+ * @description Unique identifier of the order
7796
+ * @example 371ca583-d218-4900-b236-397532cf0e52
7797
+ */
7273
7798
  id: string;
7274
- /** Order Number */
7799
+ /**
7800
+ * Order Number
7801
+ * @description Order number (often unique reference during the day)
7802
+ * @example 1
7803
+ */
7275
7804
  order_number?: string;
7276
7805
  /**
7277
7806
  * Creation Date
7278
7807
  * Format: date-time
7808
+ * @description Creation date of the order
7809
+ * @example 2025-01-01T00:00:00Z
7279
7810
  */
7280
7811
  creation_date: string;
7281
7812
  /**
7282
7813
  * Closing Date
7283
7814
  * Format: date-time
7815
+ * @description Closing date of the order
7816
+ * @example 2025-01-01T00:00:00Z
7284
7817
  */
7285
7818
  closing_date?: string;
7286
7819
  /**
7287
7820
  * Service Date
7288
7821
  * Format: date-time
7289
7822
  * @description Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
7823
+ * @example 2025-01-01T00:00:00Z
7290
7824
  */
7291
7825
  service_date?: string;
7292
7826
  /**
7293
7827
  * Device Id
7294
7828
  * @description ID of device that created the order
7829
+ * @example device-123
7295
7830
  */
7296
7831
  device_id?: string;
7297
- /** Total */
7832
+ /**
7833
+ * Total
7834
+ * @description Total amount including tax of the order
7835
+ * @example 11
7836
+ */
7298
7837
  total: number;
7299
- /** Tax Amount */
7838
+ /**
7839
+ * Tax Amount
7840
+ * @description Total amount of the taxes of the order
7841
+ * @example 1
7842
+ */
7300
7843
  tax_amount: number;
7301
7844
  /**
7302
7845
  * Total Discount
7846
+ * @description Total amount of the discounts of the order
7303
7847
  * @default 0
7848
+ * @example 10
7304
7849
  */
7305
7850
  total_discount: number;
7306
7851
  /**
7307
7852
  * Total Refund
7853
+ * @description Total amount of the refunds of the order
7308
7854
  * @default 0
7855
+ * @example 5
7309
7856
  */
7310
7857
  total_refund: number;
7311
7858
  /**
7312
7859
  * Total Tip
7860
+ * @description Total amount of the tips of the order. Tips are not part of the total of the order
7313
7861
  * @default 0
7862
+ * @example 1
7314
7863
  */
7315
7864
  total_tip: number;
7316
7865
  /**
7317
7866
  * Delivery Fee
7867
+ * @description Total amount of the delivery fees of the order
7318
7868
  * @default 0
7869
+ * @example 1
7319
7870
  */
7320
7871
  delivery_fee: number;
7321
- /** Currency */
7872
+ /**
7873
+ * Currency
7874
+ * @description Currency of the order
7875
+ * @example EUR
7876
+ */
7322
7877
  currency?: string;
7323
- /** Country */
7878
+ /**
7879
+ * Country
7880
+ * @description Country of the order, format: ISO 3166-1 codes.
7881
+ * @example FR
7882
+ */
7324
7883
  country?: string;
7325
- /** Loyalty */
7884
+ /**
7885
+ * Loyalty
7886
+ * @description Loyalty points of the order
7887
+ * @example 100
7888
+ */
7326
7889
  loyalty?: number;
7327
- /** Customer Id */
7890
+ /**
7891
+ * Customer Id
7892
+ * @description Unique identifier of the customer
7893
+ * @example customer-123
7894
+ */
7328
7895
  customer_id?: string;
7329
- /** Location Id */
7896
+ /**
7897
+ * Location Id
7898
+ * @description Unique identifier of the location
7899
+ * @example location-123
7900
+ */
7330
7901
  location_id?: string;
7331
- /** Taxes */
7332
- taxes?: components['schemas']['TotalTaxItem'][];
7333
- /** Guests */
7902
+ /**
7903
+ * Taxes
7904
+ * @description List of taxes of the order
7905
+ * @default []
7906
+ */
7907
+ taxes: components['schemas']['TotalTaxItem'][];
7908
+ /**
7909
+ * Guests
7910
+ * @description Number of guests linked to the order
7911
+ * @example 1
7912
+ */
7334
7913
  guests?: number;
7335
- /** Payments */
7914
+ /**
7915
+ * Payments
7916
+ * @description List of payments made for the order
7917
+ */
7336
7918
  payments: components['schemas']['POSPaymentItem'][];
7337
- /** Items */
7919
+ /**
7920
+ * Items
7921
+ * @description List of item lines in the order
7922
+ */
7338
7923
  items: components['schemas']['POSItem'][];
7339
7924
  };
7340
7925
  /** POSPaymentItem */
7341
7926
  POSPaymentItem: {
7342
- /** Id */
7927
+ /**
7928
+ * Id
7929
+ * @description Unique identifier of the payment
7930
+ * @example payment-123
7931
+ */
7343
7932
  id?: string;
7344
- /** Payment Method Id */
7933
+ /**
7934
+ * Payment Method Id
7935
+ * @description Unique identifier of the payment method used for the payment
7936
+ * @example payment-method-123
7937
+ */
7345
7938
  payment_method_id?: string;
7346
- /** Payment Method Name */
7939
+ /**
7940
+ * Payment Method Name
7941
+ * @description Chift's name of the payment method used for the payment
7942
+ * @example Cash
7943
+ */
7347
7944
  payment_method_name?: string;
7348
- /** Total */
7945
+ /**
7946
+ * Total
7947
+ * @description Total amount of the payment
7948
+ * @example 11
7949
+ */
7349
7950
  total: number;
7350
7951
  /**
7351
7952
  * Tip
7953
+ * @description Total amount of the tips of the payment. Tips are not part of the total of the payment
7352
7954
  * @default 0
7955
+ * @example 1
7353
7956
  */
7354
7957
  tip: number;
7355
- /** @default Unknown */
7958
+ /**
7959
+ * @description Status of the payment
7960
+ * @default Unknown
7961
+ * @example Completed
7962
+ */
7356
7963
  status: components['schemas']['backbone_common__models__pos_pms__PaymentStatus'];
7357
- /** Currency */
7964
+ /**
7965
+ * Currency
7966
+ * @description Currency of the payment
7967
+ * @example EUR
7968
+ */
7358
7969
  currency?: string;
7359
7970
  /**
7360
7971
  * Date
7361
7972
  * Format: date-time
7973
+ * @description Date of the payment
7974
+ * @example 2025-01-01T00:00:00Z
7362
7975
  */
7363
7976
  date?: string;
7364
7977
  };
7365
7978
  /** POSProductItem */
7366
7979
  POSProductItem: {
7367
- /** Id */
7980
+ /**
7981
+ * Id
7982
+ * @description Unique identifier of the product
7983
+ * @example 371ca583-d218-4900-b236-397532cf0e39
7984
+ */
7368
7985
  id: string;
7369
7986
  /**
7370
7987
  * Categories
7988
+ * @description List of categories the product belongs to
7371
7989
  * @default []
7990
+ * @example 371ca583-d218-4900-b236-397532cf0e52
7372
7991
  */
7373
7992
  categories: string[];
7374
- /** Name */
7993
+ /**
7994
+ * Name
7995
+ * @description Name ofthe product
7996
+ * @example Pizza margheritta
7997
+ */
7375
7998
  name: string;
7376
- /** Description */
7999
+ /**
8000
+ * Description
8001
+ * @description Description of the product
8002
+ * @example Pizza margheritta
8003
+ */
7377
8004
  description?: string;
7378
- /** Prices */
8005
+ /**
8006
+ * Prices
8007
+ * @description List of prices for the product
8008
+ */
7379
8009
  prices: components['schemas']['backbone_common__models__pos__common__ProductPriceItem'][];
7380
8010
  /**
7381
8011
  * Accounting Category Ids
7382
8012
  * @description Used by a POS to give one or more specific accounting categories to a product item. If not available it will use the category ids
8013
+ * @example 371ca583-d218-4900-b236-397532cf0e2
7383
8014
  */
7384
8015
  accounting_category_ids?: string[];
7385
8016
  };
@@ -7507,11 +8138,23 @@ export interface components {
7507
8138
  };
7508
8139
  /** PaymentMethods */
7509
8140
  PaymentMethods: {
7510
- /** Id */
8141
+ /**
8142
+ * Id
8143
+ * @description Unique identifier of the payment method
8144
+ * @example 371ca583-d218-4900-b236-397532cf0e52
8145
+ */
7511
8146
  id: string;
7512
- /** Name */
8147
+ /**
8148
+ * Name
8149
+ * @description Chift's name of the payment method (e.g. 'Cash', 'Card', 'Transfer', ...)
8150
+ * @example Cash
8151
+ */
7513
8152
  name: string;
7514
- /** Extra */
8153
+ /**
8154
+ * Extra
8155
+ * @description Original name of the payment method
8156
+ * @example Espèces
8157
+ */
7515
8158
  extra?: string;
7516
8159
  };
7517
8160
  /** PaymentReporting */
@@ -7565,19 +8208,47 @@ export interface components {
7565
8208
  };
7566
8209
  /** PostAddressItem */
7567
8210
  PostAddressItem: {
7568
- /** Name */
8211
+ /**
8212
+ * Name
8213
+ * @description Name given to the address (e.g. 'home')
8214
+ * @example home
8215
+ */
7569
8216
  name: string;
7570
- /** Street */
8217
+ /**
8218
+ * Street
8219
+ * @description Street name
8220
+ * @example Avenue de la République
8221
+ */
7571
8222
  street?: string;
7572
- /** Number */
8223
+ /**
8224
+ * Number
8225
+ * @description Number of the address
8226
+ * @example 123
8227
+ */
7573
8228
  number?: string;
7574
- /** Box */
8229
+ /**
8230
+ * Box
8231
+ * @description Box of the address
8232
+ * @example A
8233
+ */
7575
8234
  box?: string;
7576
- /** City */
8235
+ /**
8236
+ * City
8237
+ * @description City name
8238
+ * @example Paris
8239
+ */
7577
8240
  city: string;
7578
- /** Postal Code */
8241
+ /**
8242
+ * Postal Code
8243
+ * @description Postal code of the address
8244
+ * @example 75000
8245
+ */
7579
8246
  postal_code: string;
7580
- /** Country */
8247
+ /**
8248
+ * Country
8249
+ * @description Country, format: ISO 3166-1 codes.
8250
+ * @example FR
8251
+ */
7581
8252
  country?: string;
7582
8253
  };
7583
8254
  /** PostConsumerItem */
@@ -7958,22 +8629,35 @@ export interface components {
7958
8629
  /**
7959
8630
  * Start Date
7960
8631
  * Format: date-time
8632
+ * @description Start date of the reservation
7961
8633
  */
7962
8634
  start_date?: string;
7963
8635
  /**
7964
8636
  * End Date
7965
8637
  * Format: date-time
8638
+ * @description End date of the reservation
7966
8639
  */
7967
8640
  end_date?: string;
7968
8641
  /**
7969
8642
  * Creation Date
7970
8643
  * Format: date-time
8644
+ * @description Creation date of the reservation
7971
8645
  */
7972
8646
  creation_date?: string;
8647
+ /**
8648
+ * Resource Id
8649
+ * @description Uniuqe reference to the resource related to the reservation
8650
+ */
7973
8651
  resource_id?: components['schemas']['ChiftId'];
7974
- /** Resource Name */
8652
+ /**
8653
+ * Resource Name
8654
+ * @description Name of the resource related to the reservation
8655
+ */
7975
8656
  resource_name?: string;
7976
- /** Resource Identifier */
8657
+ /**
8658
+ * Resource Identifier
8659
+ * @description Identifier of the resource related to the reservation
8660
+ */
7977
8661
  resource_identifier?: string;
7978
8662
  };
7979
8663
  /** ReturnFeesItem */
@@ -8028,12 +8712,24 @@ export interface components {
8028
8712
  };
8029
8713
  /** SalesItem */
8030
8714
  SalesItem: {
8031
- /** Total */
8715
+ /**
8716
+ * Total
8717
+ * @description Total amount including tax of the sales
8718
+ * @example 10
8719
+ */
8032
8720
  total: number;
8033
- /** Tax Amount */
8721
+ /**
8722
+ * Tax Amount
8723
+ * @description Total amount of the taxes
8724
+ * @example 1
8725
+ */
8034
8726
  tax_amount: number;
8035
- /** Taxes */
8036
- taxes?: components['schemas']['TotalTaxItem'][];
8727
+ /**
8728
+ * Taxes
8729
+ * @description List of taxes grouped by tax rateapplied to the sales
8730
+ * @default []
8731
+ */
8732
+ taxes: components['schemas']['TotalTaxItem'][];
8037
8733
  };
8038
8734
  /** ShippingRefund */
8039
8735
  ShippingRefund: {
@@ -8381,11 +9077,23 @@ export interface components {
8381
9077
  };
8382
9078
  /** TotalTaxItem */
8383
9079
  TotalTaxItem: {
8384
- /** Tax Rate */
9080
+ /**
9081
+ * Tax Rate
9082
+ * @description Tax rate
9083
+ * @example 10
9084
+ */
8385
9085
  tax_rate: number;
8386
- /** Tax Amount */
9086
+ /**
9087
+ * Tax Amount
9088
+ * @description Tax amount
9089
+ * @example 1
9090
+ */
8387
9091
  tax_amount: number;
8388
- /** Total */
9092
+ /**
9093
+ * Total
9094
+ * @description Total amount including tax
9095
+ * @example 11
9096
+ */
8389
9097
  total: number;
8390
9098
  };
8391
9099
  /**
@@ -8506,7 +9214,11 @@ export interface components {
8506
9214
  };
8507
9215
  /** UpdateOrderItem */
8508
9216
  UpdateOrderItem: {
8509
- /** Customer Id */
9217
+ /**
9218
+ * Customer Id
9219
+ * @description Unique identifier of the customer
9220
+ * @example 371ca583-d218-4900-b236-397532cf0e52
9221
+ */
8510
9222
  customer_id?: string;
8511
9223
  };
8512
9224
  /** ValidationError */
@@ -9322,44 +10034,82 @@ export interface components {
9322
10034
  /**
9323
10035
  * Creation Date
9324
10036
  * Format: date-time
10037
+ * @description Creation date of the invoice
9325
10038
  */
9326
10039
  creation_date?: string;
9327
10040
  /**
9328
10041
  * Closing Date
9329
10042
  * Format: date-time
10043
+ * @description Closing date of the invoice
9330
10044
  */
9331
10045
  closing_date?: string;
9332
- /** Partners */
10046
+ /**
10047
+ * Partners
10048
+ * @description List of partners related to the invoice
10049
+ */
9333
10050
  partners?: components['schemas']['InvoicePartnerItem'][];
9334
10051
  };
9335
10052
  /** ProductCategoryItem */
9336
10053
  backbone_common__models__pos__common__ProductCategoryItem: {
9337
- /** Id */
10054
+ /**
10055
+ * Id
10056
+ * @description Unique identifier of the category
10057
+ * @example 371ca583-d218-4900-b236-397532cf0e52
10058
+ */
9338
10059
  id: string;
9339
- /** Name */
10060
+ /**
10061
+ * Name
10062
+ * @description Name given to the category
10063
+ * @example Pizza
10064
+ */
9340
10065
  name: string;
9341
- /** Description */
10066
+ /**
10067
+ * Description
10068
+ * @description Description of the category
10069
+ * @example Delicious pizza
10070
+ */
9342
10071
  description?: string;
9343
10072
  /**
9344
10073
  * Id Parent
9345
10074
  * @description Indicates if the category belongs to a parent category
10075
+ * @example 371ca583-d218-4900-b236-397532cf0e55
9346
10076
  */
9347
10077
  id_parent?: string;
9348
10078
  };
9349
10079
  /** ProductPriceItem */
9350
10080
  backbone_common__models__pos__common__ProductPriceItem: {
9351
- /** Unit Price */
10081
+ /**
10082
+ * Unit Price
10083
+ * @description Unit price (without tax) of the product
10084
+ * @example 10
10085
+ */
9352
10086
  unit_price: number;
9353
- /** Tax Rate */
10087
+ /**
10088
+ * Tax Rate
10089
+ * @description Tax rate applied to the product
10090
+ * @example 10
10091
+ */
9354
10092
  tax_rate?: number;
9355
10093
  };
9356
10094
  /** DiscountItem */
9357
10095
  backbone_common__models__pos_pms__DiscountItem: {
9358
- /** Name */
10096
+ /**
10097
+ * Name
10098
+ * @description Name of the discount
10099
+ * @example Percentage discount
10100
+ */
9359
10101
  name?: string;
9360
- /** Total */
10102
+ /**
10103
+ * Total
10104
+ * @description Total amount of the discount
10105
+ * @example 10
10106
+ */
9361
10107
  total: number;
9362
- /** @default UNKNOWN */
10108
+ /**
10109
+ * @description Type of the discount
10110
+ * @default UNKNOWN
10111
+ * @example offered
10112
+ */
9363
10113
  type: components['schemas']['DiscountType'];
9364
10114
  };
9365
10115
  /**
@@ -11392,6 +12142,7 @@ export interface operations {
11392
12142
  folder_id?: string;
11393
12143
  force_financial_period?: string;
11394
12144
  regroup_lines?: components['schemas']['BoolParam'];
12145
+ force_currency_exchange?: components['schemas']['BoolParam'];
11395
12146
  };
11396
12147
  header?: never;
11397
12148
  path: {
@@ -11449,6 +12200,7 @@ export interface operations {
11449
12200
  folder_id?: string;
11450
12201
  force_financial_period?: string;
11451
12202
  regroup_lines?: components['schemas']['BoolParam'];
12203
+ force_currency_exchange?: components['schemas']['BoolParam'];
11452
12204
  };
11453
12205
  header?: never;
11454
12206
  path: {
@@ -11708,6 +12460,52 @@ export interface operations {
11708
12460
  };
11709
12461
  };
11710
12462
  };
12463
+ accounting_create_ledger_account: {
12464
+ parameters: {
12465
+ query?: {
12466
+ folder_id?: string;
12467
+ };
12468
+ header?: never;
12469
+ path: {
12470
+ consumer_id: string;
12471
+ };
12472
+ cookie?: never;
12473
+ };
12474
+ requestBody: {
12475
+ content: {
12476
+ 'application/json': components['schemas']['LedgerAccountItemIn'];
12477
+ };
12478
+ };
12479
+ responses: {
12480
+ /** @description Successful Response */
12481
+ 200: {
12482
+ headers: {
12483
+ [name: string]: unknown;
12484
+ };
12485
+ content: {
12486
+ 'application/json': components['schemas']['AccountItem'];
12487
+ };
12488
+ };
12489
+ /** @description Bad Request */
12490
+ 400: {
12491
+ headers: {
12492
+ [name: string]: unknown;
12493
+ };
12494
+ content: {
12495
+ 'application/json': components['schemas']['ChiftError'];
12496
+ };
12497
+ };
12498
+ /** @description Validation Error */
12499
+ 422: {
12500
+ headers: {
12501
+ [name: string]: unknown;
12502
+ };
12503
+ content: {
12504
+ 'application/json': components['schemas']['HTTPValidationError'];
12505
+ };
12506
+ };
12507
+ };
12508
+ };
11711
12509
  accounting_get_analytic_accounts: {
11712
12510
  parameters: {
11713
12511
  query?: {
@@ -12787,13 +13585,11 @@ export interface operations {
12787
13585
  };
12788
13586
  responses: {
12789
13587
  /** @description Successful Response */
12790
- 201: {
13588
+ 204: {
12791
13589
  headers: {
12792
13590
  [name: string]: unknown;
12793
13591
  };
12794
- content: {
12795
- 'application/json': unknown;
12796
- };
13592
+ content?: never;
12797
13593
  };
12798
13594
  /** @description Bad Request */
12799
13595
  400: {
@@ -13012,6 +13808,7 @@ export interface operations {
13012
13808
  query?: {
13013
13809
  folder_id?: string;
13014
13810
  financial_counterpart_account?: string;
13811
+ force_currency_exchange?: components['schemas']['BoolParam'];
13015
13812
  };
13016
13813
  header?: never;
13017
13814
  path: {
@@ -13068,6 +13865,7 @@ export interface operations {
13068
13865
  query?: {
13069
13866
  folder_id?: string;
13070
13867
  financial_counterpart_account?: string;
13868
+ force_currency_exchange?: components['schemas']['BoolParam'];
13071
13869
  };
13072
13870
  header?: never;
13073
13871
  path: {
@@ -15999,6 +16797,74 @@ export interface operations {
15999
16797
  };
16000
16798
  };
16001
16799
  };
16800
+ pms_get_customer: {
16801
+ parameters: {
16802
+ query?: never;
16803
+ header?: never;
16804
+ path: {
16805
+ consumer_id: string;
16806
+ customer_id: string;
16807
+ };
16808
+ cookie?: never;
16809
+ };
16810
+ requestBody?: never;
16811
+ responses: {
16812
+ /** @description Successful Response */
16813
+ 200: {
16814
+ headers: {
16815
+ [name: string]: unknown;
16816
+ };
16817
+ content: {
16818
+ 'application/json': components['schemas']['PMSCustomerItem'];
16819
+ };
16820
+ };
16821
+ /** @description Bad Request */
16822
+ 400: {
16823
+ headers: {
16824
+ [name: string]: unknown;
16825
+ };
16826
+ content: {
16827
+ 'application/json': components['schemas']['ChiftError'];
16828
+ };
16829
+ };
16830
+ /** @description Not Found */
16831
+ 404: {
16832
+ headers: {
16833
+ [name: string]: unknown;
16834
+ };
16835
+ content: {
16836
+ 'application/json': components['schemas']['ChiftError'];
16837
+ };
16838
+ };
16839
+ /** @description Method Not Allowed */
16840
+ 405: {
16841
+ headers: {
16842
+ [name: string]: unknown;
16843
+ };
16844
+ content: {
16845
+ 'application/json': components['schemas']['ChiftError'];
16846
+ };
16847
+ };
16848
+ /** @description Validation Error */
16849
+ 422: {
16850
+ headers: {
16851
+ [name: string]: unknown;
16852
+ };
16853
+ content: {
16854
+ 'application/json': components['schemas']['HTTPValidationError'];
16855
+ };
16856
+ };
16857
+ /** @description Bad Gateway */
16858
+ 502: {
16859
+ headers: {
16860
+ [name: string]: unknown;
16861
+ };
16862
+ content: {
16863
+ 'application/json': components['schemas']['ChiftError'];
16864
+ };
16865
+ };
16866
+ };
16867
+ };
16002
16868
  pms_get_locations: {
16003
16869
  parameters: {
16004
16870
  query?: {