@getyetty-sdk/pennylane 2026.2.6 → 2026.2.11

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/dist/index.d.mts CHANGED
@@ -1285,6 +1285,7 @@ declare const InvoiceStatuses: {
1285
1285
  readonly INCOMPLETE: "incomplete";
1286
1286
  readonly CANCELLED: "cancelled";
1287
1287
  readonly PAID: "paid";
1288
+ readonly PARTIALLY_PAID: "partially_paid";
1288
1289
  readonly PARTIALLY_CANCELLED: "partially_cancelled";
1289
1290
  readonly UPCOMING: "upcoming";
1290
1291
  readonly LATE: "late";
@@ -1354,7 +1355,7 @@ type CustomerInvoicesResponse = {
1354
1355
  * Invoice paid status (set to True if the invoice is paid)
1355
1356
  */
1356
1357
  paid: boolean;
1357
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
1358
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
1358
1359
  discount: {
1359
1360
  /**
1360
1361
  * Discount type.
@@ -4999,6 +5000,28 @@ type GetJournalsData = {
4999
5000
  body?: never;
5000
5001
  path?: never;
5001
5002
  query?: {
5003
+ /**
5004
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5005
+ *
5006
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5007
+ *
5008
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5009
+ *
5010
+ * **Preview phase:**
5011
+ * From January 14th to April 7th 2026.
5012
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5013
+ *
5014
+ * **Sunset phase:**
5015
+ * From April 8th to June 30th 2026.
5016
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5017
+ *
5018
+ * **Cleanup phase:**
5019
+ * Starting July 1st 2026
5020
+ * The old behavior will no longer be available. You must have migrated by this point.
5021
+ *
5022
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5023
+ */
5024
+ use_2026_api_changes?: boolean;
5002
5025
  /**
5003
5026
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5004
5027
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1. This parameter is deprecated.
@@ -5189,7 +5212,30 @@ type PostJournalsData = {
5189
5212
  label: string;
5190
5213
  };
5191
5214
  path?: never;
5192
- query?: never;
5215
+ query?: {
5216
+ /**
5217
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5218
+ *
5219
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5220
+ *
5221
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5222
+ *
5223
+ * **Preview phase:**
5224
+ * From January 14th to April 7th 2026.
5225
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5226
+ *
5227
+ * **Sunset phase:**
5228
+ * From April 8th to June 30th 2026.
5229
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5230
+ *
5231
+ * **Cleanup phase:**
5232
+ * Starting July 1st 2026
5233
+ * The old behavior will no longer be available. You must have migrated by this point.
5234
+ *
5235
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5236
+ */
5237
+ use_2026_api_changes?: boolean;
5238
+ };
5193
5239
  url: '/api/external/v2/journals';
5194
5240
  };
5195
5241
  type PostJournalsErrors = {
@@ -5268,7 +5314,30 @@ type GetJournalData = {
5268
5314
  */
5269
5315
  id: number;
5270
5316
  };
5271
- query?: never;
5317
+ query?: {
5318
+ /**
5319
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5320
+ *
5321
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5322
+ *
5323
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5324
+ *
5325
+ * **Preview phase:**
5326
+ * From January 14th to April 7th 2026.
5327
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5328
+ *
5329
+ * **Sunset phase:**
5330
+ * From April 8th to June 30th 2026.
5331
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5332
+ *
5333
+ * **Cleanup phase:**
5334
+ * Starting July 1st 2026
5335
+ * The old behavior will no longer be available. You must have migrated by this point.
5336
+ *
5337
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5338
+ */
5339
+ use_2026_api_changes?: boolean;
5340
+ };
5272
5341
  url: '/api/external/v2/journals/{id}';
5273
5342
  };
5274
5343
  type GetJournalErrors = {
@@ -5336,6 +5405,28 @@ type GetLedgerAccountsData = {
5336
5405
  body?: never;
5337
5406
  path?: never;
5338
5407
  query?: {
5408
+ /**
5409
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5410
+ *
5411
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5412
+ *
5413
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5414
+ *
5415
+ * **Preview phase:**
5416
+ * From January 14th to April 7th 2026.
5417
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5418
+ *
5419
+ * **Sunset phase:**
5420
+ * From April 8th to June 30th 2026.
5421
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5422
+ *
5423
+ * **Cleanup phase:**
5424
+ * Starting July 1st 2026
5425
+ * The old behavior will no longer be available. You must have migrated by this point.
5426
+ *
5427
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5428
+ */
5429
+ use_2026_api_changes?: boolean;
5339
5430
  /**
5340
5431
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5341
5432
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1.
@@ -5530,7 +5621,30 @@ type PostLedgerAccountsData = {
5530
5621
  country_alpha2?: 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'ES' | 'FI' | 'FR' | 'GR' | 'HR' | 'HU' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'MT' | 'NL' | 'PL' | 'PT' | 'RO' | 'SE' | 'SI' | 'SK' | 'GB' | 'MC' | 'CH' | 'AD' | 'MU' | 'NO' | 'any';
5531
5622
  };
5532
5623
  path?: never;
5533
- query?: never;
5624
+ query?: {
5625
+ /**
5626
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5627
+ *
5628
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5629
+ *
5630
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5631
+ *
5632
+ * **Preview phase:**
5633
+ * From January 14th to April 7th 2026.
5634
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5635
+ *
5636
+ * **Sunset phase:**
5637
+ * From April 8th to June 30th 2026.
5638
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5639
+ *
5640
+ * **Cleanup phase:**
5641
+ * Starting July 1st 2026
5642
+ * The old behavior will no longer be available. You must have migrated by this point.
5643
+ *
5644
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5645
+ */
5646
+ use_2026_api_changes?: boolean;
5647
+ };
5534
5648
  url: '/api/external/v2/ledger_accounts';
5535
5649
  };
5536
5650
  type PostLedgerAccountsErrors = {
@@ -5627,7 +5741,30 @@ type GetLedgerAccountData = {
5627
5741
  */
5628
5742
  id: number;
5629
5743
  };
5630
- query?: never;
5744
+ query?: {
5745
+ /**
5746
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5747
+ *
5748
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5749
+ *
5750
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5751
+ *
5752
+ * **Preview phase:**
5753
+ * From January 14th to April 7th 2026.
5754
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5755
+ *
5756
+ * **Sunset phase:**
5757
+ * From April 8th to June 30th 2026.
5758
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5759
+ *
5760
+ * **Cleanup phase:**
5761
+ * Starting July 1st 2026
5762
+ * The old behavior will no longer be available. You must have migrated by this point.
5763
+ *
5764
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5765
+ */
5766
+ use_2026_api_changes?: boolean;
5767
+ };
5631
5768
  url: '/api/external/v2/ledger_accounts/{id}';
5632
5769
  };
5633
5770
  type GetLedgerAccountErrors = {
@@ -5726,7 +5863,30 @@ type UpdateLedgerAccountData = {
5726
5863
  */
5727
5864
  id: number;
5728
5865
  };
5729
- query?: never;
5866
+ query?: {
5867
+ /**
5868
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
5869
+ *
5870
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
5871
+ *
5872
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
5873
+ *
5874
+ * **Preview phase:**
5875
+ * From January 14th to April 7th 2026.
5876
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
5877
+ *
5878
+ * **Sunset phase:**
5879
+ * From April 8th to June 30th 2026.
5880
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
5881
+ *
5882
+ * **Cleanup phase:**
5883
+ * Starting July 1st 2026
5884
+ * The old behavior will no longer be available. You must have migrated by this point.
5885
+ *
5886
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5887
+ */
5888
+ use_2026_api_changes?: boolean;
5889
+ };
5730
5890
  url: '/api/external/v2/ledger_accounts/{id}';
5731
5891
  };
5732
5892
  type UpdateLedgerAccountErrors = {
@@ -5994,6 +6154,28 @@ type GetLedgerEntriesData = {
5994
6154
  body?: never;
5995
6155
  path?: never;
5996
6156
  query?: {
6157
+ /**
6158
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
6159
+ *
6160
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
6161
+ *
6162
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
6163
+ *
6164
+ * **Preview phase:**
6165
+ * From January 14th to April 7th 2026.
6166
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
6167
+ *
6168
+ * **Sunset phase:**
6169
+ * From April 8th to June 30th 2026.
6170
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
6171
+ *
6172
+ * **Cleanup phase:**
6173
+ * Starting July 1st 2026
6174
+ * The old behavior will no longer be available. You must have migrated by this point.
6175
+ *
6176
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
6177
+ */
6178
+ use_2026_api_changes?: boolean;
5997
6179
  /**
5998
6180
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
5999
6181
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1. This parameter is deprecated.
@@ -6303,7 +6485,30 @@ type PostLedgerEntriesData = {
6303
6485
  }>;
6304
6486
  };
6305
6487
  path?: never;
6306
- query?: never;
6488
+ query?: {
6489
+ /**
6490
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
6491
+ *
6492
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
6493
+ *
6494
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
6495
+ *
6496
+ * **Preview phase:**
6497
+ * From January 14th to April 7th 2026.
6498
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
6499
+ *
6500
+ * **Sunset phase:**
6501
+ * From April 8th to June 30th 2026.
6502
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
6503
+ *
6504
+ * **Cleanup phase:**
6505
+ * Starting July 1st 2026
6506
+ * The old behavior will no longer be available. You must have migrated by this point.
6507
+ *
6508
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
6509
+ */
6510
+ use_2026_api_changes?: boolean;
6511
+ };
6307
6512
  url: '/api/external/v2/ledger_entries';
6308
6513
  };
6309
6514
  type PostLedgerEntriesErrors = {
@@ -6479,7 +6684,30 @@ type GetLedgerEntryData = {
6479
6684
  */
6480
6685
  id: number;
6481
6686
  };
6482
- query?: never;
6687
+ query?: {
6688
+ /**
6689
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
6690
+ *
6691
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
6692
+ *
6693
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
6694
+ *
6695
+ * **Preview phase:**
6696
+ * From January 14th to April 7th 2026.
6697
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
6698
+ *
6699
+ * **Sunset phase:**
6700
+ * From April 8th to June 30th 2026.
6701
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
6702
+ *
6703
+ * **Cleanup phase:**
6704
+ * Starting July 1st 2026
6705
+ * The old behavior will no longer be available. You must have migrated by this point.
6706
+ *
6707
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
6708
+ */
6709
+ use_2026_api_changes?: boolean;
6710
+ };
6483
6711
  url: '/api/external/v2/ledger_entries/{id}';
6484
6712
  };
6485
6713
  type GetLedgerEntryErrors = {
@@ -6719,7 +6947,30 @@ type PutLedgerEntriesData = {
6719
6947
  */
6720
6948
  id: string;
6721
6949
  };
6722
- query?: never;
6950
+ query?: {
6951
+ /**
6952
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
6953
+ *
6954
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
6955
+ *
6956
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
6957
+ *
6958
+ * **Preview phase:**
6959
+ * From January 14th to April 7th 2026.
6960
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
6961
+ *
6962
+ * **Sunset phase:**
6963
+ * From April 8th to June 30th 2026.
6964
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
6965
+ *
6966
+ * **Cleanup phase:**
6967
+ * Starting July 1st 2026
6968
+ * The old behavior will no longer be available. You must have migrated by this point.
6969
+ *
6970
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
6971
+ */
6972
+ use_2026_api_changes?: boolean;
6973
+ };
6723
6974
  url: '/api/external/v2/ledger_entries/{id}';
6724
6975
  };
6725
6976
  type PutLedgerEntriesErrors = {
@@ -6896,6 +7147,28 @@ type GetLedgerEntriesLedgerEntryLinesData = {
6896
7147
  ledger_entry_id: number;
6897
7148
  };
6898
7149
  query?: {
7150
+ /**
7151
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
7152
+ *
7153
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
7154
+ *
7155
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
7156
+ *
7157
+ * **Preview phase:**
7158
+ * From January 14th to April 7th 2026.
7159
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
7160
+ *
7161
+ * **Sunset phase:**
7162
+ * From April 8th to June 30th 2026.
7163
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
7164
+ *
7165
+ * **Cleanup phase:**
7166
+ * Starting July 1st 2026
7167
+ * The old behavior will no longer be available. You must have migrated by this point.
7168
+ *
7169
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7170
+ */
7171
+ use_2026_api_changes?: boolean;
6899
7172
  /**
6900
7173
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
6901
7174
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1.
@@ -7110,6 +7383,28 @@ type GetLedgerEntryLinesData = {
7110
7383
  body?: never;
7111
7384
  path?: never;
7112
7385
  query?: {
7386
+ /**
7387
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
7388
+ *
7389
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
7390
+ *
7391
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
7392
+ *
7393
+ * **Preview phase:**
7394
+ * From January 14th to April 7th 2026.
7395
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
7396
+ *
7397
+ * **Sunset phase:**
7398
+ * From April 8th to June 30th 2026.
7399
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
7400
+ *
7401
+ * **Cleanup phase:**
7402
+ * Starting July 1st 2026
7403
+ * The old behavior will no longer be available. You must have migrated by this point.
7404
+ *
7405
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7406
+ */
7407
+ use_2026_api_changes?: boolean;
7113
7408
  /**
7114
7409
  * Cursor for pagination. Use this to fetch the next set of results.
7115
7410
  * The cursor is an opaque string returned in the previous response's metadata.
@@ -7304,7 +7599,30 @@ type GetLedgerEntryLineData = {
7304
7599
  */
7305
7600
  id: number;
7306
7601
  };
7307
- query?: never;
7602
+ query?: {
7603
+ /**
7604
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
7605
+ *
7606
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
7607
+ *
7608
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
7609
+ *
7610
+ * **Preview phase:**
7611
+ * From January 14th to April 7th 2026.
7612
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
7613
+ *
7614
+ * **Sunset phase:**
7615
+ * From April 8th to June 30th 2026.
7616
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
7617
+ *
7618
+ * **Cleanup phase:**
7619
+ * Starting July 1st 2026
7620
+ * The old behavior will no longer be available. You must have migrated by this point.
7621
+ *
7622
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7623
+ */
7624
+ use_2026_api_changes?: boolean;
7625
+ };
7308
7626
  url: '/api/external/v2/ledger_entry_lines/{id}';
7309
7627
  };
7310
7628
  type GetLedgerEntryLineErrors = {
@@ -7466,7 +7784,30 @@ type DeleteLedgerEntryLinesUnletterData = {
7466
7784
  }>;
7467
7785
  };
7468
7786
  path?: never;
7469
- query?: never;
7787
+ query?: {
7788
+ /**
7789
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
7790
+ *
7791
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
7792
+ *
7793
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
7794
+ *
7795
+ * **Preview phase:**
7796
+ * From January 14th to April 7th 2026.
7797
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
7798
+ *
7799
+ * **Sunset phase:**
7800
+ * From April 8th to June 30th 2026.
7801
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
7802
+ *
7803
+ * **Cleanup phase:**
7804
+ * Starting July 1st 2026
7805
+ * The old behavior will no longer be available. You must have migrated by this point.
7806
+ *
7807
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7808
+ */
7809
+ use_2026_api_changes?: boolean;
7810
+ };
7470
7811
  url: '/api/external/v2/ledger_entry_lines/lettering';
7471
7812
  };
7472
7813
  type DeleteLedgerEntryLinesUnletterErrors = {
@@ -7559,7 +7900,30 @@ type PostLedgerEntryLinesLetterData = {
7559
7900
  }>;
7560
7901
  };
7561
7902
  path?: never;
7562
- query?: never;
7903
+ query?: {
7904
+ /**
7905
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
7906
+ *
7907
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
7908
+ *
7909
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
7910
+ *
7911
+ * **Preview phase:**
7912
+ * From January 14th to April 7th 2026.
7913
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
7914
+ *
7915
+ * **Sunset phase:**
7916
+ * From April 8th to June 30th 2026.
7917
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
7918
+ *
7919
+ * **Cleanup phase:**
7920
+ * Starting July 1st 2026
7921
+ * The old behavior will no longer be available. You must have migrated by this point.
7922
+ *
7923
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7924
+ */
7925
+ use_2026_api_changes?: boolean;
7926
+ };
7563
7927
  url: '/api/external/v2/ledger_entry_lines/lettering';
7564
7928
  };
7565
7929
  type PostLedgerEntryLinesLetterErrors = {
@@ -7639,6 +8003,28 @@ type GetLedgerEntryLinesLetteredLedgerEntryLinesData = {
7639
8003
  ledger_entry_line_id: number;
7640
8004
  };
7641
8005
  query?: {
8006
+ /**
8007
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
8008
+ *
8009
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
8010
+ *
8011
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
8012
+ *
8013
+ * **Preview phase:**
8014
+ * From January 14th to April 7th 2026.
8015
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
8016
+ *
8017
+ * **Sunset phase:**
8018
+ * From April 8th to June 30th 2026.
8019
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
8020
+ *
8021
+ * **Cleanup phase:**
8022
+ * Starting July 1st 2026
8023
+ * The old behavior will no longer be available. You must have migrated by this point.
8024
+ *
8025
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
8026
+ */
8027
+ use_2026_api_changes?: boolean;
7642
8028
  /**
7643
8029
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7644
8030
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1. This parameter is deprecated.
@@ -7887,6 +8273,28 @@ type GetLedgerEntryLinesCategoriesData = {
7887
8273
  ledger_entry_line_id: number;
7888
8274
  };
7889
8275
  query?: {
8276
+ /**
8277
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
8278
+ *
8279
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
8280
+ *
8281
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
8282
+ *
8283
+ * **Preview phase:**
8284
+ * From January 14th to April 7th 2026.
8285
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
8286
+ *
8287
+ * **Sunset phase:**
8288
+ * From April 8th to June 30th 2026.
8289
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
8290
+ *
8291
+ * **Cleanup phase:**
8292
+ * Starting July 1st 2026
8293
+ * The old behavior will no longer be available. You must have migrated by this point.
8294
+ *
8295
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
8296
+ */
8297
+ use_2026_api_changes?: boolean;
7890
8298
  /**
7891
8299
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
7892
8300
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1.
@@ -8072,7 +8480,30 @@ type PutLedgerEntryLinesCategoriesData = {
8072
8480
  */
8073
8481
  ledger_entry_line_id: number;
8074
8482
  };
8075
- query?: never;
8483
+ query?: {
8484
+ /**
8485
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
8486
+ *
8487
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
8488
+ *
8489
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
8490
+ *
8491
+ * **Preview phase:**
8492
+ * From January 14th to April 7th 2026.
8493
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
8494
+ *
8495
+ * **Sunset phase:**
8496
+ * From April 8th to June 30th 2026.
8497
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
8498
+ *
8499
+ * **Cleanup phase:**
8500
+ * Starting July 1st 2026
8501
+ * The old behavior will no longer be available. You must have migrated by this point.
8502
+ *
8503
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
8504
+ */
8505
+ use_2026_api_changes?: boolean;
8506
+ };
8076
8507
  url: '/api/external/v2/ledger_entry_lines/{ledger_entry_line_id}/categories';
8077
8508
  };
8078
8509
  type PutLedgerEntryLinesCategoriesErrors = {
@@ -8158,6 +8589,28 @@ type GetCustomerInvoicesData = {
8158
8589
  body?: never;
8159
8590
  path?: never;
8160
8591
  query?: {
8592
+ /**
8593
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
8594
+ *
8595
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
8596
+ *
8597
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
8598
+ *
8599
+ * **Preview phase:**
8600
+ * From January 14th to April 7th 2026.
8601
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
8602
+ *
8603
+ * **Sunset phase:**
8604
+ * From April 8th to June 30th 2026.
8605
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
8606
+ *
8607
+ * **Cleanup phase:**
8608
+ * Starting July 1st 2026
8609
+ * The old behavior will no longer be available. You must have migrated by this point.
8610
+ *
8611
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
8612
+ */
8613
+ use_2026_api_changes?: boolean;
8161
8614
  /**
8162
8615
  * Cursor for pagination. Use this to fetch the next set of results.
8163
8616
  * The cursor is an opaque string returned in the previous response's metadata.
@@ -8307,7 +8760,7 @@ type GetCustomerInvoicesResponses = {
8307
8760
  * Invoice paid status (set to True if the invoice is paid)
8308
8761
  */
8309
8762
  paid: boolean;
8310
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
8763
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
8311
8764
  discount: {
8312
8765
  /**
8313
8766
  * Discount type.
@@ -8964,7 +9417,30 @@ type PostCustomerInvoicesData = {
8964
9417
  }>;
8965
9418
  };
8966
9419
  path?: never;
8967
- query?: never;
9420
+ query?: {
9421
+ /**
9422
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
9423
+ *
9424
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
9425
+ *
9426
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
9427
+ *
9428
+ * **Preview phase:**
9429
+ * From January 14th to April 7th 2026.
9430
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
9431
+ *
9432
+ * **Sunset phase:**
9433
+ * From April 8th to June 30th 2026.
9434
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
9435
+ *
9436
+ * **Cleanup phase:**
9437
+ * Starting July 1st 2026
9438
+ * The old behavior will no longer be available. You must have migrated by this point.
9439
+ *
9440
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
9441
+ */
9442
+ use_2026_api_changes?: boolean;
9443
+ };
8968
9444
  url: '/api/external/v2/customer_invoices';
8969
9445
  };
8970
9446
  type PostCustomerInvoicesErrors = {
@@ -9072,7 +9548,7 @@ type PostCustomerInvoicesResponses = {
9072
9548
  * Invoice paid status (set to True if the invoice is paid)
9073
9549
  */
9074
9550
  paid: boolean;
9075
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
9551
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
9076
9552
  discount: {
9077
9553
  /**
9078
9554
  * Discount type.
@@ -9374,7 +9850,30 @@ type ImportCustomerInvoicesData = {
9374
9850
  external_reference?: string;
9375
9851
  };
9376
9852
  path?: never;
9377
- query?: never;
9853
+ query?: {
9854
+ /**
9855
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
9856
+ *
9857
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
9858
+ *
9859
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
9860
+ *
9861
+ * **Preview phase:**
9862
+ * From January 14th to April 7th 2026.
9863
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
9864
+ *
9865
+ * **Sunset phase:**
9866
+ * From April 8th to June 30th 2026.
9867
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
9868
+ *
9869
+ * **Cleanup phase:**
9870
+ * Starting July 1st 2026
9871
+ * The old behavior will no longer be available. You must have migrated by this point.
9872
+ *
9873
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
9874
+ */
9875
+ use_2026_api_changes?: boolean;
9876
+ };
9378
9877
  url: '/api/external/v2/customer_invoices/import';
9379
9878
  };
9380
9879
  type ImportCustomerInvoicesErrors = {
@@ -9489,7 +9988,7 @@ type ImportCustomerInvoicesResponses = {
9489
9988
  * Invoice paid status (set to True if the invoice is paid)
9490
9989
  */
9491
9990
  paid: boolean;
9492
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
9991
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
9493
9992
  discount: {
9494
9993
  /**
9495
9994
  * Discount type.
@@ -9663,7 +10162,30 @@ type CreateCustomerInvoiceFromQuoteData = {
9663
10162
  customer_invoice_template_id?: number;
9664
10163
  };
9665
10164
  path?: never;
9666
- query?: never;
10165
+ query?: {
10166
+ /**
10167
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
10168
+ *
10169
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
10170
+ *
10171
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
10172
+ *
10173
+ * **Preview phase:**
10174
+ * From January 14th to April 7th 2026.
10175
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
10176
+ *
10177
+ * **Sunset phase:**
10178
+ * From April 8th to June 30th 2026.
10179
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
10180
+ *
10181
+ * **Cleanup phase:**
10182
+ * Starting July 1st 2026
10183
+ * The old behavior will no longer be available. You must have migrated by this point.
10184
+ *
10185
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
10186
+ */
10187
+ use_2026_api_changes?: boolean;
10188
+ };
9667
10189
  url: '/api/external/v2/customer_invoices/create_from_quote';
9668
10190
  };
9669
10191
  type CreateCustomerInvoiceFromQuoteErrors = {
@@ -9771,7 +10293,7 @@ type CreateCustomerInvoiceFromQuoteResponses = {
9771
10293
  * Invoice paid status (set to True if the invoice is paid)
9772
10294
  */
9773
10295
  paid: boolean;
9774
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
10296
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
9775
10297
  discount: {
9776
10298
  /**
9777
10299
  * Discount type.
@@ -10584,7 +11106,30 @@ type GetBillingSubscriptionData = {
10584
11106
  */
10585
11107
  id: number;
10586
11108
  };
10587
- query?: never;
11109
+ query?: {
11110
+ /**
11111
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
11112
+ *
11113
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
11114
+ *
11115
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
11116
+ *
11117
+ * **Preview phase:**
11118
+ * From January 14th to April 7th 2026.
11119
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
11120
+ *
11121
+ * **Sunset phase:**
11122
+ * From April 8th to June 30th 2026.
11123
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
11124
+ *
11125
+ * **Cleanup phase:**
11126
+ * Starting July 1st 2026
11127
+ * The old behavior will no longer be available. You must have migrated by this point.
11128
+ *
11129
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
11130
+ */
11131
+ use_2026_api_changes?: boolean;
11132
+ };
10588
11133
  url: '/api/external/v2/billing_subscriptions/{id}';
10589
11134
  };
10590
11135
  type GetBillingSubscriptionErrors = {
@@ -11076,7 +11621,30 @@ type PutBillingSubscriptionsData = {
11076
11621
  */
11077
11622
  id: number;
11078
11623
  };
11079
- query?: never;
11624
+ query?: {
11625
+ /**
11626
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
11627
+ *
11628
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
11629
+ *
11630
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
11631
+ *
11632
+ * **Preview phase:**
11633
+ * From January 14th to April 7th 2026.
11634
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
11635
+ *
11636
+ * **Sunset phase:**
11637
+ * From April 8th to June 30th 2026.
11638
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
11639
+ *
11640
+ * **Cleanup phase:**
11641
+ * Starting July 1st 2026
11642
+ * The old behavior will no longer be available. You must have migrated by this point.
11643
+ *
11644
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
11645
+ */
11646
+ use_2026_api_changes?: boolean;
11647
+ };
11080
11648
  url: '/api/external/v2/billing_subscriptions/{id}';
11081
11649
  };
11082
11650
  type PutBillingSubscriptionsErrors = {
@@ -12960,7 +13528,30 @@ type GetCompanyCustomerData = {
12960
13528
  */
12961
13529
  id: string;
12962
13530
  };
12963
- query?: never;
13531
+ query?: {
13532
+ /**
13533
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
13534
+ *
13535
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
13536
+ *
13537
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
13538
+ *
13539
+ * **Preview phase:**
13540
+ * From January 14th to April 7th 2026.
13541
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
13542
+ *
13543
+ * **Sunset phase:**
13544
+ * From April 8th to June 30th 2026.
13545
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
13546
+ *
13547
+ * **Cleanup phase:**
13548
+ * Starting July 1st 2026
13549
+ * The old behavior will no longer be available. You must have migrated by this point.
13550
+ *
13551
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
13552
+ */
13553
+ use_2026_api_changes?: boolean;
13554
+ };
12964
13555
  url: '/api/external/v2/company_customers/{id}';
12965
13556
  };
12966
13557
  type GetCompanyCustomerErrors = {
@@ -13119,7 +13710,30 @@ type PutCompanyCustomerData = {
13119
13710
  */
13120
13711
  id: string;
13121
13712
  };
13122
- query?: never;
13713
+ query?: {
13714
+ /**
13715
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
13716
+ *
13717
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
13718
+ *
13719
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
13720
+ *
13721
+ * **Preview phase:**
13722
+ * From January 14th to April 7th 2026.
13723
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
13724
+ *
13725
+ * **Sunset phase:**
13726
+ * From April 8th to June 30th 2026.
13727
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
13728
+ *
13729
+ * **Cleanup phase:**
13730
+ * Starting July 1st 2026
13731
+ * The old behavior will no longer be available. You must have migrated by this point.
13732
+ *
13733
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
13734
+ */
13735
+ use_2026_api_changes?: boolean;
13736
+ };
13123
13737
  url: '/api/external/v2/company_customers/{id}';
13124
13738
  };
13125
13739
  type PutCompanyCustomerErrors = {
@@ -13422,7 +14036,30 @@ type GetIndividualCustomerData = {
13422
14036
  */
13423
14037
  id: string;
13424
14038
  };
13425
- query?: never;
14039
+ query?: {
14040
+ /**
14041
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
14042
+ *
14043
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
14044
+ *
14045
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
14046
+ *
14047
+ * **Preview phase:**
14048
+ * From January 14th to April 7th 2026.
14049
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
14050
+ *
14051
+ * **Sunset phase:**
14052
+ * From April 8th to June 30th 2026.
14053
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
14054
+ *
14055
+ * **Cleanup phase:**
14056
+ * Starting July 1st 2026
14057
+ * The old behavior will no longer be available. You must have migrated by this point.
14058
+ *
14059
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
14060
+ */
14061
+ use_2026_api_changes?: boolean;
14062
+ };
13426
14063
  url: '/api/external/v2/individual_customers/{id}';
13427
14064
  };
13428
14065
  type GetIndividualCustomerErrors = {
@@ -13577,7 +14214,30 @@ type PutIndividualCustomerData = {
13577
14214
  */
13578
14215
  id: string;
13579
14216
  };
13580
- query?: never;
14217
+ query?: {
14218
+ /**
14219
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
14220
+ *
14221
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
14222
+ *
14223
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
14224
+ *
14225
+ * **Preview phase:**
14226
+ * From January 14th to April 7th 2026.
14227
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
14228
+ *
14229
+ * **Sunset phase:**
14230
+ * From April 8th to June 30th 2026.
14231
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
14232
+ *
14233
+ * **Cleanup phase:**
14234
+ * Starting July 1st 2026
14235
+ * The old behavior will no longer be available. You must have migrated by this point.
14236
+ *
14237
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
14238
+ */
14239
+ use_2026_api_changes?: boolean;
14240
+ };
13581
14241
  url: '/api/external/v2/individual_customers/{id}';
13582
14242
  };
13583
14243
  type PutIndividualCustomerErrors = {
@@ -13941,7 +14601,30 @@ type GetCustomerData = {
13941
14601
  */
13942
14602
  id: number;
13943
14603
  };
13944
- query?: never;
14604
+ query?: {
14605
+ /**
14606
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
14607
+ *
14608
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
14609
+ *
14610
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
14611
+ *
14612
+ * **Preview phase:**
14613
+ * From January 14th to April 7th 2026.
14614
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
14615
+ *
14616
+ * **Sunset phase:**
14617
+ * From April 8th to June 30th 2026.
14618
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
14619
+ *
14620
+ * **Cleanup phase:**
14621
+ * Starting July 1st 2026
14622
+ * The old behavior will no longer be available. You must have migrated by this point.
14623
+ *
14624
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
14625
+ */
14626
+ use_2026_api_changes?: boolean;
14627
+ };
13945
14628
  url: '/api/external/v2/customers/{id}';
13946
14629
  };
13947
14630
  type GetCustomerErrors = {
@@ -14733,7 +15416,30 @@ type GetSupplierData = {
14733
15416
  */
14734
15417
  id: number;
14735
15418
  };
14736
- query?: never;
15419
+ query?: {
15420
+ /**
15421
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
15422
+ *
15423
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
15424
+ *
15425
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
15426
+ *
15427
+ * **Preview phase:**
15428
+ * From January 14th to April 7th 2026.
15429
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
15430
+ *
15431
+ * **Sunset phase:**
15432
+ * From April 8th to June 30th 2026.
15433
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
15434
+ *
15435
+ * **Cleanup phase:**
15436
+ * Starting July 1st 2026
15437
+ * The old behavior will no longer be available. You must have migrated by this point.
15438
+ *
15439
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
15440
+ */
15441
+ use_2026_api_changes?: boolean;
15442
+ };
14737
15443
  url: '/api/external/v2/suppliers/{id}';
14738
15444
  };
14739
15445
  type GetSupplierErrors = {
@@ -14870,7 +15576,30 @@ type PutSupplierData = {
14870
15576
  path: {
14871
15577
  id: number;
14872
15578
  };
14873
- query?: never;
15579
+ query?: {
15580
+ /**
15581
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
15582
+ *
15583
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
15584
+ *
15585
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
15586
+ *
15587
+ * **Preview phase:**
15588
+ * From January 14th to April 7th 2026.
15589
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
15590
+ *
15591
+ * **Sunset phase:**
15592
+ * From April 8th to June 30th 2026.
15593
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
15594
+ *
15595
+ * **Cleanup phase:**
15596
+ * Starting July 1st 2026
15597
+ * The old behavior will no longer be available. You must have migrated by this point.
15598
+ *
15599
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
15600
+ */
15601
+ use_2026_api_changes?: boolean;
15602
+ };
14874
15603
  url: '/api/external/v2/suppliers/{id}';
14875
15604
  };
14876
15605
  type PutSupplierErrors = {
@@ -16567,7 +17296,30 @@ type GetCustomerInvoiceData = {
16567
17296
  */
16568
17297
  id: number;
16569
17298
  };
16570
- query?: never;
17299
+ query?: {
17300
+ /**
17301
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
17302
+ *
17303
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
17304
+ *
17305
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
17306
+ *
17307
+ * **Preview phase:**
17308
+ * From January 14th to April 7th 2026.
17309
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
17310
+ *
17311
+ * **Sunset phase:**
17312
+ * From April 8th to June 30th 2026.
17313
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
17314
+ *
17315
+ * **Cleanup phase:**
17316
+ * Starting July 1st 2026
17317
+ * The old behavior will no longer be available. You must have migrated by this point.
17318
+ *
17319
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
17320
+ */
17321
+ use_2026_api_changes?: boolean;
17322
+ };
16571
17323
  url: '/api/external/v2/customer_invoices/{id}';
16572
17324
  };
16573
17325
  type GetCustomerInvoiceErrors = {
@@ -16668,7 +17420,7 @@ type GetCustomerInvoiceResponses = {
16668
17420
  * Invoice paid status (set to True if the invoice is paid)
16669
17421
  */
16670
17422
  paid: boolean;
16671
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
17423
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
16672
17424
  discount: {
16673
17425
  /**
16674
17426
  * Discount type.
@@ -17097,7 +17849,30 @@ type UpdateCustomerInvoiceData = {
17097
17849
  */
17098
17850
  id: number;
17099
17851
  };
17100
- query?: never;
17852
+ query?: {
17853
+ /**
17854
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
17855
+ *
17856
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
17857
+ *
17858
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
17859
+ *
17860
+ * **Preview phase:**
17861
+ * From January 14th to April 7th 2026.
17862
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
17863
+ *
17864
+ * **Sunset phase:**
17865
+ * From April 8th to June 30th 2026.
17866
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
17867
+ *
17868
+ * **Cleanup phase:**
17869
+ * Starting July 1st 2026
17870
+ * The old behavior will no longer be available. You must have migrated by this point.
17871
+ *
17872
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
17873
+ */
17874
+ use_2026_api_changes?: boolean;
17875
+ };
17101
17876
  url: '/api/external/v2/customer_invoices/{id}';
17102
17877
  };
17103
17878
  type UpdateCustomerInvoiceErrors = {
@@ -17205,7 +17980,7 @@ type UpdateCustomerInvoiceResponses = {
17205
17980
  * Invoice paid status (set to True if the invoice is paid)
17206
17981
  */
17207
17982
  paid: boolean;
17208
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
17983
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
17209
17984
  discount: {
17210
17985
  /**
17211
17986
  * Discount type.
@@ -17957,7 +18732,30 @@ type UpdateImportedCustomerInvoiceData = {
17957
18732
  */
17958
18733
  id: number;
17959
18734
  };
17960
- query?: never;
18735
+ query?: {
18736
+ /**
18737
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
18738
+ *
18739
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
18740
+ *
18741
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
18742
+ *
18743
+ * **Preview phase:**
18744
+ * From January 14th to April 7th 2026.
18745
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
18746
+ *
18747
+ * **Sunset phase:**
18748
+ * From April 8th to June 30th 2026.
18749
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
18750
+ *
18751
+ * **Cleanup phase:**
18752
+ * Starting July 1st 2026
18753
+ * The old behavior will no longer be available. You must have migrated by this point.
18754
+ *
18755
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
18756
+ */
18757
+ use_2026_api_changes?: boolean;
18758
+ };
17961
18759
  url: '/api/external/v2/customer_invoices/{id}/update_imported';
17962
18760
  };
17963
18761
  type UpdateImportedCustomerInvoiceErrors = {
@@ -18065,7 +18863,7 @@ type UpdateImportedCustomerInvoiceResponses = {
18065
18863
  * Invoice paid status (set to True if the invoice is paid)
18066
18864
  */
18067
18865
  paid: boolean;
18068
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
18866
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
18069
18867
  discount: {
18070
18868
  /**
18071
18869
  * Discount type.
@@ -18227,7 +19025,30 @@ type FinalizeCustomerInvoiceData = {
18227
19025
  */
18228
19026
  id: number;
18229
19027
  };
18230
- query?: never;
19028
+ query?: {
19029
+ /**
19030
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
19031
+ *
19032
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
19033
+ *
19034
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
19035
+ *
19036
+ * **Preview phase:**
19037
+ * From January 14th to April 7th 2026.
19038
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
19039
+ *
19040
+ * **Sunset phase:**
19041
+ * From April 8th to June 30th 2026.
19042
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
19043
+ *
19044
+ * **Cleanup phase:**
19045
+ * Starting July 1st 2026
19046
+ * The old behavior will no longer be available. You must have migrated by this point.
19047
+ *
19048
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
19049
+ */
19050
+ use_2026_api_changes?: boolean;
19051
+ };
18231
19052
  url: '/api/external/v2/customer_invoices/{id}/finalize';
18232
19053
  };
18233
19054
  type FinalizeCustomerInvoiceErrors = {
@@ -18335,7 +19156,7 @@ type FinalizeCustomerInvoiceResponses = {
18335
19156
  * Invoice paid status (set to True if the invoice is paid)
18336
19157
  */
18337
19158
  paid: boolean;
18338
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
19159
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
18339
19160
  discount: {
18340
19161
  /**
18341
19162
  * Discount type.
@@ -18502,7 +19323,30 @@ type LinkCreditNoteData = {
18502
19323
  */
18503
19324
  id: number;
18504
19325
  };
18505
- query?: never;
19326
+ query?: {
19327
+ /**
19328
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
19329
+ *
19330
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
19331
+ *
19332
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
19333
+ *
19334
+ * **Preview phase:**
19335
+ * From January 14th to April 7th 2026.
19336
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
19337
+ *
19338
+ * **Sunset phase:**
19339
+ * From April 8th to June 30th 2026.
19340
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
19341
+ *
19342
+ * **Cleanup phase:**
19343
+ * Starting July 1st 2026
19344
+ * The old behavior will no longer be available. You must have migrated by this point.
19345
+ *
19346
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
19347
+ */
19348
+ use_2026_api_changes?: boolean;
19349
+ };
18506
19350
  url: '/api/external/v2/customer_invoices/{id}/link_credit_note';
18507
19351
  };
18508
19352
  type LinkCreditNoteErrors = {
@@ -18610,7 +19454,7 @@ type LinkCreditNoteResponses = {
18610
19454
  * Invoice paid status (set to True if the invoice is paid)
18611
19455
  */
18612
19456
  paid: boolean;
18613
- status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
19457
+ status: 'archived' | 'incomplete' | 'cancelled' | 'paid' | 'partially_paid' | 'partially_cancelled' | 'upcoming' | 'late' | 'draft' | 'credit_note';
18614
19458
  discount: {
18615
19459
  /**
18616
19460
  * Discount type.
@@ -18921,6 +19765,28 @@ type GetSupplierInvoicesData = {
18921
19765
  body?: never;
18922
19766
  path?: never;
18923
19767
  query?: {
19768
+ /**
19769
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
19770
+ *
19771
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
19772
+ *
19773
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
19774
+ *
19775
+ * **Preview phase:**
19776
+ * From January 14th to April 7th 2026.
19777
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
19778
+ *
19779
+ * **Sunset phase:**
19780
+ * From April 8th to June 30th 2026.
19781
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
19782
+ *
19783
+ * **Cleanup phase:**
19784
+ * Starting July 1st 2026
19785
+ * The old behavior will no longer be available. You must have migrated by this point.
19786
+ *
19787
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
19788
+ */
19789
+ use_2026_api_changes?: boolean;
18924
19790
  /**
18925
19791
  * Cursor for pagination. Use this to fetch the next set of results.
18926
19792
  * The cursor is an opaque string returned in the previous response's metadata.
@@ -19179,7 +20045,30 @@ type GetSupplierInvoiceData = {
19179
20045
  */
19180
20046
  id: number;
19181
20047
  };
19182
- query?: never;
20048
+ query?: {
20049
+ /**
20050
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
20051
+ *
20052
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
20053
+ *
20054
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
20055
+ *
20056
+ * **Preview phase:**
20057
+ * From January 14th to April 7th 2026.
20058
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
20059
+ *
20060
+ * **Sunset phase:**
20061
+ * From April 8th to June 30th 2026.
20062
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
20063
+ *
20064
+ * **Cleanup phase:**
20065
+ * Starting July 1st 2026
20066
+ * The old behavior will no longer be available. You must have migrated by this point.
20067
+ *
20068
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
20069
+ */
20070
+ use_2026_api_changes?: boolean;
20071
+ };
19183
20072
  url: '/api/external/v2/supplier_invoices/{id}';
19184
20073
  };
19185
20074
  type GetSupplierInvoiceErrors = {
@@ -20685,7 +21574,30 @@ type ImportSupplierInvoiceData = {
20685
21574
  external_reference?: string;
20686
21575
  };
20687
21576
  path?: never;
20688
- query?: never;
21577
+ query?: {
21578
+ /**
21579
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
21580
+ *
21581
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
21582
+ *
21583
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
21584
+ *
21585
+ * **Preview phase:**
21586
+ * From January 14th to April 7th 2026.
21587
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
21588
+ *
21589
+ * **Sunset phase:**
21590
+ * From April 8th to June 30th 2026.
21591
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
21592
+ *
21593
+ * **Cleanup phase:**
21594
+ * Starting July 1st 2026
21595
+ * The old behavior will no longer be available. You must have migrated by this point.
21596
+ *
21597
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
21598
+ */
21599
+ use_2026_api_changes?: boolean;
21600
+ };
20689
21601
  url: '/api/external/v2/supplier_invoices/import';
20690
21602
  };
20691
21603
  type ImportSupplierInvoiceErrors = {
@@ -20904,7 +21816,30 @@ type ValidateAccountingSupplierInvoiceData = {
20904
21816
  path: {
20905
21817
  id: number;
20906
21818
  };
20907
- query?: never;
21819
+ query?: {
21820
+ /**
21821
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
21822
+ *
21823
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
21824
+ *
21825
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
21826
+ *
21827
+ * **Preview phase:**
21828
+ * From January 14th to April 7th 2026.
21829
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
21830
+ *
21831
+ * **Sunset phase:**
21832
+ * From April 8th to June 30th 2026.
21833
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
21834
+ *
21835
+ * **Cleanup phase:**
21836
+ * Starting July 1st 2026
21837
+ * The old behavior will no longer be available. You must have migrated by this point.
21838
+ *
21839
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
21840
+ */
21841
+ use_2026_api_changes?: boolean;
21842
+ };
20908
21843
  url: '/api/external/v2/supplier_invoices/{id}/validate_accounting';
20909
21844
  };
20910
21845
  type ValidateAccountingSupplierInvoiceErrors = {
@@ -21970,6 +22905,28 @@ type GetTrialBalanceData = {
21970
22905
  body?: never;
21971
22906
  path?: never;
21972
22907
  query: {
22908
+ /**
22909
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
22910
+ *
22911
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
22912
+ *
22913
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
22914
+ *
22915
+ * **Preview phase:**
22916
+ * From January 14th to April 7th 2026.
22917
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
22918
+ *
22919
+ * **Sunset phase:**
22920
+ * From April 8th to June 30th 2026.
22921
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
22922
+ *
22923
+ * **Cleanup phase:**
22924
+ * Starting July 1st 2026
22925
+ * The old behavior will no longer be available. You must have migrated by this point.
22926
+ *
22927
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
22928
+ */
22929
+ use_2026_api_changes?: boolean;
21973
22930
  /**
21974
22931
  * The start of the period you want the trial balance for.
21975
22932
  */
@@ -22146,6 +23103,28 @@ type CompanyFiscalYearsData = {
22146
23103
  body?: never;
22147
23104
  path?: never;
22148
23105
  query?: {
23106
+ /**
23107
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
23108
+ *
23109
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
23110
+ *
23111
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
23112
+ *
23113
+ * **Preview phase:**
23114
+ * From January 14th to April 7th 2026.
23115
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
23116
+ *
23117
+ * **Sunset phase:**
23118
+ * From April 8th to June 30th 2026.
23119
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
23120
+ *
23121
+ * **Cleanup phase:**
23122
+ * Starting July 1st 2026
23123
+ * The old behavior will no longer be available. You must have migrated by this point.
23124
+ *
23125
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
23126
+ */
23127
+ use_2026_api_changes?: boolean;
22149
23128
  /**
22150
23129
  * This pagination system is **DEPRECATED**. For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
22151
23130
  * Items are paginated, this is the current page which will be returned. The page index is starting at 1.
@@ -22953,6 +23932,28 @@ type GetLedgerEntryLineChangesData = {
22953
23932
  body?: never;
22954
23933
  path?: never;
22955
23934
  query?: {
23935
+ /**
23936
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
23937
+ *
23938
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
23939
+ *
23940
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
23941
+ *
23942
+ * **Preview phase:**
23943
+ * From January 14th to April 7th 2026.
23944
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
23945
+ *
23946
+ * **Sunset phase:**
23947
+ * From April 8th to June 30th 2026.
23948
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
23949
+ *
23950
+ * **Cleanup phase:**
23951
+ * Starting July 1st 2026
23952
+ * The old behavior will no longer be available. You must have migrated by this point.
23953
+ *
23954
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
23955
+ */
23956
+ use_2026_api_changes?: boolean;
22956
23957
  /**
22957
23958
  * Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.
22958
23959
  */
@@ -27589,7 +28590,30 @@ type PostSepaMandatesData = {
27589
28590
  customer_id: number;
27590
28591
  };
27591
28592
  path?: never;
27592
- query?: never;
28593
+ query?: {
28594
+ /**
28595
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
28596
+ *
28597
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
28598
+ *
28599
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
28600
+ *
28601
+ * **Preview phase:**
28602
+ * From January 14th to April 7th 2026.
28603
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
28604
+ *
28605
+ * **Sunset phase:**
28606
+ * From April 8th to June 30th 2026.
28607
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
28608
+ *
28609
+ * **Cleanup phase:**
28610
+ * Starting July 1st 2026
28611
+ * The old behavior will no longer be available. You must have migrated by this point.
28612
+ *
28613
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
28614
+ */
28615
+ use_2026_api_changes?: boolean;
28616
+ };
27593
28617
  url: '/api/external/v2/sepa_mandates';
27594
28618
  };
27595
28619
  type PostSepaMandatesErrors = {
@@ -27929,7 +28953,30 @@ type PutSepaMandateData = {
27929
28953
  */
27930
28954
  id: number;
27931
28955
  };
27932
- query?: never;
28956
+ query?: {
28957
+ /**
28958
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
28959
+ *
28960
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
28961
+ *
28962
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
28963
+ *
28964
+ * **Preview phase:**
28965
+ * From January 14th to April 7th 2026.
28966
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
28967
+ *
28968
+ * **Sunset phase:**
28969
+ * From April 8th to June 30th 2026.
28970
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
28971
+ *
28972
+ * **Cleanup phase:**
28973
+ * Starting July 1st 2026
28974
+ * The old behavior will no longer be available. You must have migrated by this point.
28975
+ *
28976
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
28977
+ */
28978
+ use_2026_api_changes?: boolean;
28979
+ };
27933
28980
  url: '/api/external/v2/sepa_mandates/{id}';
27934
28981
  };
27935
28982
  type PutSepaMandateErrors = {
@@ -28302,7 +29349,30 @@ type PostGocardlessMandateMailRequestsData = {
28302
29349
  };
28303
29350
  };
28304
29351
  path?: never;
28305
- query?: never;
29352
+ query?: {
29353
+ /**
29354
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
29355
+ *
29356
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
29357
+ *
29358
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
29359
+ *
29360
+ * **Preview phase:**
29361
+ * From January 14th to April 7th 2026.
29362
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
29363
+ *
29364
+ * **Sunset phase:**
29365
+ * From April 8th to June 30th 2026.
29366
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
29367
+ *
29368
+ * **Cleanup phase:**
29369
+ * Starting July 1st 2026
29370
+ * The old behavior will no longer be available. You must have migrated by this point.
29371
+ *
29372
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
29373
+ */
29374
+ use_2026_api_changes?: boolean;
29375
+ };
28306
29376
  url: '/api/external/v2/gocardless_mandates/mail_requests';
28307
29377
  };
28308
29378
  type PostGocardlessMandateMailRequestsErrors = {
@@ -28455,7 +29525,30 @@ type PostGocardlessMandateAssociationsData = {
28455
29525
  */
28456
29526
  gocardless_mandate_id: number;
28457
29527
  };
28458
- query?: never;
29528
+ query?: {
29529
+ /**
29530
+ * If you are already using the `X-Use-2026-API-Changes` header, you can ignore this parameter.
29531
+ *
29532
+ * The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.
29533
+ *
29534
+ * **For new user**, please use this parameter with `true` value to opt in directly to the new version of the API.
29535
+ *
29536
+ * **Preview phase:**
29537
+ * From January 14th to April 7th 2026.
29538
+ * Opt in by setting this attribute to `true` to test and migrate to the new behavior.
29539
+ *
29540
+ * **Sunset phase:**
29541
+ * From April 8th to June 30th 2026.
29542
+ * The new behavior becomes the default. Set this attribute to `false` if you need additional time to migrate.
29543
+ *
29544
+ * **Cleanup phase:**
29545
+ * Starting July 1st 2026
29546
+ * The old behavior will no longer be available. You must have migrated by this point.
29547
+ *
29548
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
29549
+ */
29550
+ use_2026_api_changes?: boolean;
29551
+ };
28459
29552
  url: '/api/external/v2/gocardless_mandates/{gocardless_mandate_id}/associations';
28460
29553
  };
28461
29554
  type PostGocardlessMandateAssociationsErrors = {
@@ -30246,7 +31339,7 @@ declare const TemplatesAvailablesLocalesSchema: {
30246
31339
  };
30247
31340
  declare const InvoiceStatusesSchema: {
30248
31341
  readonly type: "string";
30249
- readonly enum: readonly ["archived", "incomplete", "cancelled", "paid", "partially_cancelled", "upcoming", "late", "draft", "credit_note"];
31342
+ readonly enum: readonly ["archived", "incomplete", "cancelled", "paid", "partially_paid", "partially_cancelled", "upcoming", "late", "draft", "credit_note"];
30250
31343
  };
30251
31344
  declare const DiscountTypeSchema: {
30252
31345
  readonly description: "Discount type.\n- absolute if it is an amount\n- relative if it is a percentage\n";
@@ -30333,7 +31426,7 @@ declare const CustomerInvoices__ResponseSchema: {
30333
31426
  };
30334
31427
  readonly status: {
30335
31428
  readonly type: "string";
30336
- readonly enum: readonly ["archived", "incomplete", "cancelled", "paid", "partially_cancelled", "upcoming", "late", "draft", "credit_note"];
31429
+ readonly enum: readonly ["archived", "incomplete", "cancelled", "paid", "partially_paid", "partially_cancelled", "upcoming", "late", "draft", "credit_note"];
30337
31430
  };
30338
31431
  readonly discount: {
30339
31432
  readonly type: "object";
@@ -37907,7 +39000,12 @@ declare const updateCategory: <ThrowOnError extends boolean = false>(options: Op
37907
39000
  /**
37908
39001
  * Get the trial balance
37909
39002
  *
37910
- * This endpoint returns the trial balance of the current company for the given period.
39003
+ * This endpoint returns the trial balance of the current company
39004
+ * for the given period.
39005
+ *
39006
+ * **DEPRECATED BEHAVIOR:**
39007
+ * `page` and `per_page` params are **deprecated**. Please use `cursor` and `limit` for pagination instead.
39008
+ * For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.
37911
39009
  *
37912
39010
  * > ℹ️
37913
39011
  * > This endpoint requires one of the following scopes: `trial_balance:readonly`