@vrplatform/api 1.3.1-stage.1370 → 1.3.1-stage.1372

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.
@@ -264,6 +264,41 @@ export interface paths {
264
264
  patch?: never;
265
265
  trace?: never;
266
266
  };
267
+ "/reservations/{reservationId}/adjustments": {
268
+ parameters: {
269
+ query?: never;
270
+ header?: never;
271
+ path?: never;
272
+ cookie?: never;
273
+ };
274
+ get?: never;
275
+ put?: never;
276
+ /** @description Create a reservation adjustment line */
277
+ post: operations["createReservationAdjustment"];
278
+ delete?: never;
279
+ options?: never;
280
+ head?: never;
281
+ patch?: never;
282
+ trace?: never;
283
+ };
284
+ "/reservations/{reservationId}/adjustments/{id}": {
285
+ parameters: {
286
+ query?: never;
287
+ header?: never;
288
+ path?: never;
289
+ cookie?: never;
290
+ };
291
+ get?: never;
292
+ /** @description Update a reservation adjustment line */
293
+ put: operations["updateReservationAdjustment"];
294
+ post?: never;
295
+ /** @description Delete a reservation adjustment line */
296
+ delete: operations["deleteReservationAdjustment"];
297
+ options?: never;
298
+ head?: never;
299
+ patch?: never;
300
+ trace?: never;
301
+ };
267
302
  "/listings/ownership-periods": {
268
303
  parameters: {
269
304
  query?: never;
@@ -6101,6 +6136,1171 @@ export interface operations {
6101
6136
  };
6102
6137
  };
6103
6138
  };
6139
+ createReservationAdjustment: {
6140
+ parameters: {
6141
+ query?: never;
6142
+ header?: {
6143
+ "X-Team-Id"?: string;
6144
+ };
6145
+ path: {
6146
+ reservationId: string;
6147
+ };
6148
+ cookie?: never;
6149
+ };
6150
+ requestBody: {
6151
+ content: {
6152
+ "application/json": {
6153
+ id?: string | null;
6154
+ description?: string | null;
6155
+ reservationRef?: string | null;
6156
+ /** @description Value in cents (100 = 1€) */
6157
+ amount: number;
6158
+ accountId?: string | null;
6159
+ accountRef?: string | null;
6160
+ metadata?: {
6161
+ [key: string]: unknown;
6162
+ } | null;
6163
+ type?: string | null;
6164
+ /** Format: uuid */
6165
+ recurringFeeId?: string | null;
6166
+ /** @enum {string|null} */
6167
+ party?: "owners" | "manager" | null;
6168
+ generalLedgerPostingAt?: string | null;
6169
+ };
6170
+ };
6171
+ };
6172
+ responses: {
6173
+ /** @description Successful response */
6174
+ 200: {
6175
+ headers: {
6176
+ [name: string]: unknown;
6177
+ };
6178
+ content: {
6179
+ "application/json": {
6180
+ currency: string | null;
6181
+ uniqueRef?: string | null;
6182
+ guestName?: string | null;
6183
+ bookerName?: string | null;
6184
+ checkIn?: string | null;
6185
+ checkOut?: string | null;
6186
+ generalLedgerPostingAt?: string | null;
6187
+ bookedAt?: string | null;
6188
+ cancelledAt?: string | null;
6189
+ bookingPlatform?: string | null;
6190
+ confirmationCode?: string | null;
6191
+ pmsReferenceCode?: string | null;
6192
+ guests?: number | null;
6193
+ userdata: {
6194
+ [key: string]: unknown;
6195
+ } | null;
6196
+ metadata: {
6197
+ [key: string]: unknown;
6198
+ } | null;
6199
+ /** Format: uuid */
6200
+ id: string;
6201
+ lock?: {
6202
+ /** @enum {string} */
6203
+ status: "locked" | "unlocked";
6204
+ booksClosed?: {
6205
+ date: string;
6206
+ } | null;
6207
+ ownerStatement?: {
6208
+ ids: string[];
6209
+ } | null;
6210
+ statementPeriod?: {
6211
+ hits: {
6212
+ /** Format: uuid */
6213
+ listingId: string;
6214
+ txnAt: string;
6215
+ openFrom: string;
6216
+ }[];
6217
+ } | null;
6218
+ } | null;
6219
+ issues: ({
6220
+ /** @enum {string} */
6221
+ code: "lineNotFound";
6222
+ /** @enum {string} */
6223
+ severity: "error";
6224
+ context: {
6225
+ lineIds: string[];
6226
+ };
6227
+ message: string;
6228
+ } | {
6229
+ /** @enum {string} */
6230
+ code: "unbalancedJournalEntries";
6231
+ /** @enum {string} */
6232
+ severity: "error";
6233
+ context: {
6234
+ difference: number;
6235
+ };
6236
+ message: string;
6237
+ } | {
6238
+ /** @enum {string} */
6239
+ code: "unassignedAccount";
6240
+ /** @enum {string} */
6241
+ severity: "error";
6242
+ context: {
6243
+ accountIds: string[];
6244
+ };
6245
+ } | {
6246
+ /** @enum {string} */
6247
+ code: "priorToStartDate";
6248
+ /** @enum {string} */
6249
+ severity: "warning";
6250
+ context: {
6251
+ startDate?: string | null;
6252
+ };
6253
+ } | {
6254
+ /** @enum {string} */
6255
+ code: "inactiveListing";
6256
+ /** @enum {string} */
6257
+ severity: "warning";
6258
+ context: {
6259
+ startDate?: string | null;
6260
+ };
6261
+ } | {
6262
+ /** @enum {string} */
6263
+ code: "inactiveConnection";
6264
+ /** @enum {string} */
6265
+ severity: "warning";
6266
+ context: Record<string, never>;
6267
+ } | {
6268
+ /** @enum {string} */
6269
+ code: "guestTotalsZero";
6270
+ /** @enum {string} */
6271
+ severity: "warning";
6272
+ context: Record<string, never>;
6273
+ } | {
6274
+ /** @enum {string} */
6275
+ code: "guestTotalsMismatch";
6276
+ /** @enum {string} */
6277
+ severity: "warning";
6278
+ context: {
6279
+ difference: number;
6280
+ };
6281
+ message: string;
6282
+ })[];
6283
+ connection?: {
6284
+ /** Format: uuid */
6285
+ id: string;
6286
+ name: string;
6287
+ /** @enum {string} */
6288
+ status: "active" | "inactive";
6289
+ uniqueRef?: string | null;
6290
+ appId: string;
6291
+ } | null;
6292
+ nights?: number | null;
6293
+ /** @enum {string} */
6294
+ status: "booked" | "canceled" | "inactive";
6295
+ financials: {
6296
+ totals: {
6297
+ tax: number;
6298
+ manager: number;
6299
+ owner: number;
6300
+ reservation: number;
6301
+ expense: number;
6302
+ deposit: number;
6303
+ guest: number;
6304
+ };
6305
+ lines?: {
6306
+ name: string;
6307
+ /** @enum {string|null} */
6308
+ type?: "reservation" | "reservation_adjustment" | "reservation_adjustment_cancellation" | "reservation_fee" | "reservation_fee_adjustment" | "reservation_fee_tax" | "transaction_transfer" | "transaction_transfer_line" | "reservation_line" | "transaction_deposit" | "transaction_deposit_channelFee" | "transaction_deposit_line" | "transaction_deposit_coHost" | "transaction_deposit_merchantFee" | "transaction_deposit_vat" | "transaction_deposit_reserve" | "transaction_deposit_openingBalance" | "transaction_deposit_openingAdvance" | "transaction_deposit_refund" | "transaction_expense" | "transaction_expense_line" | "transaction_expense_markup" | "transaction_expense_markup_tax" | "transaction_expense_payment" | null;
6309
+ /** @enum {string|null} */
6310
+ party?: "owners" | "manager" | null;
6311
+ /** @enum {string} */
6312
+ status: "active" | "inactive";
6313
+ amount: number;
6314
+ /** @enum {string|null} */
6315
+ inactiveReason?: "reservationCancelled" | "referenceAccount" | "deferredRevenue" | "system" | null;
6316
+ account?: {
6317
+ id: string;
6318
+ name: string;
6319
+ uniqueRef?: string | null;
6320
+ /** @enum {string} */
6321
+ status: "active" | "inactive";
6322
+ /** @enum {string} */
6323
+ type: "ledger" | "bank" | "recurringFee" | "nonPosting";
6324
+ } | null;
6325
+ recurringFee?: {
6326
+ id: string;
6327
+ uniqueRef: string;
6328
+ name: string;
6329
+ /** @enum {string} */
6330
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6331
+ } | null;
6332
+ transaction?: {
6333
+ id: string;
6334
+ /** @enum {string} */
6335
+ status: "active" | "inactive";
6336
+ /** @description Value in cents (100 = 1€) */
6337
+ amount: number;
6338
+ account?: {
6339
+ id: string;
6340
+ name: string;
6341
+ uniqueRef?: string | null;
6342
+ /** @enum {string} */
6343
+ status: "active" | "inactive";
6344
+ } | null;
6345
+ date: string;
6346
+ description: string;
6347
+ currency: string;
6348
+ /** @enum {string} */
6349
+ type: "deposit" | "expense" | "transfer";
6350
+ contact?: {
6351
+ /** Format: uuid */
6352
+ id: string;
6353
+ name?: string | null;
6354
+ uniqueRef?: string | null;
6355
+ } | null;
6356
+ connection?: {
6357
+ /** Format: uuid */
6358
+ id: string;
6359
+ name: string;
6360
+ /** @enum {string} */
6361
+ status: "active" | "inactive";
6362
+ uniqueRef?: string | null;
6363
+ appId: string;
6364
+ } | null;
6365
+ uniqueRef?: string | null;
6366
+ recurringTemplate?: {
6367
+ id: string;
6368
+ } | null;
6369
+ } | null;
6370
+ line?: {
6371
+ id: string;
6372
+ type?: string | null;
6373
+ description?: string | null;
6374
+ } | null;
6375
+ lock?: {
6376
+ /** @enum {string} */
6377
+ status: "locked" | "unlocked";
6378
+ booksClosed?: {
6379
+ date: string;
6380
+ } | null;
6381
+ ownerStatement?: {
6382
+ ids: string[];
6383
+ } | null;
6384
+ statementPeriod?: {
6385
+ hits: {
6386
+ /** Format: uuid */
6387
+ listingId: string;
6388
+ txnAt: string;
6389
+ openFrom: string;
6390
+ }[];
6391
+ } | null;
6392
+ } | null;
6393
+ }[] | null;
6394
+ };
6395
+ listing?: {
6396
+ /** Format: uuid */
6397
+ id: string;
6398
+ name: string;
6399
+ uniqueRef?: string | null;
6400
+ } | null;
6401
+ listingConnection?: {
6402
+ /** Format: uuid */
6403
+ id: string;
6404
+ name: string;
6405
+ uniqueRef?: string | null;
6406
+ } | null;
6407
+ payment: {
6408
+ expected: number;
6409
+ received: number;
6410
+ status: ("unpaid" | "underpaid" | "overpaid" | "paid") | "coHost";
6411
+ };
6412
+ source?: {
6413
+ /** Format: uuid */
6414
+ id: string;
6415
+ type: string;
6416
+ /** @enum {string|null} */
6417
+ status?: "active" | "inactive" | null;
6418
+ } | null;
6419
+ lines: {
6420
+ /** Format: uuid */
6421
+ id: string;
6422
+ uniqueRef?: string | null;
6423
+ type: string;
6424
+ description?: string | null;
6425
+ /** @description Value in cents (100 = 1€) */
6426
+ amount: number;
6427
+ connectionId?: string | null;
6428
+ metadata?: {
6429
+ [key: string]: unknown;
6430
+ } | null;
6431
+ account?: {
6432
+ id: string;
6433
+ name: string;
6434
+ uniqueRef?: string | null;
6435
+ /** @enum {string} */
6436
+ status: "active" | "inactive";
6437
+ } | null;
6438
+ isExcluded?: boolean | null;
6439
+ }[];
6440
+ /** @description Adjustments are manually added financial lines that are not part of the booking platform */
6441
+ adjustments: {
6442
+ /** Format: uuid */
6443
+ id: string;
6444
+ description?: string | null;
6445
+ /** @description Value in cents (100 = 1€) */
6446
+ amount: number;
6447
+ metadata?: {
6448
+ [key: string]: unknown;
6449
+ } | null;
6450
+ type?: string | null;
6451
+ /** @enum {string|null} */
6452
+ party?: "owners" | "manager" | null;
6453
+ generalLedgerPostingAt?: string | null;
6454
+ account?: {
6455
+ id: string;
6456
+ name: string;
6457
+ uniqueRef?: string | null;
6458
+ /** @enum {string} */
6459
+ status: "active" | "inactive";
6460
+ } | null;
6461
+ recurringFee?: {
6462
+ id: string;
6463
+ uniqueRef: string;
6464
+ name: string;
6465
+ /** @enum {string} */
6466
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6467
+ } | null;
6468
+ lock?: {
6469
+ /** @enum {string} */
6470
+ status: "locked" | "unlocked";
6471
+ booksClosed?: {
6472
+ date: string;
6473
+ } | null;
6474
+ ownerStatement?: {
6475
+ ids: string[];
6476
+ } | null;
6477
+ statementPeriod?: {
6478
+ hits: {
6479
+ /** Format: uuid */
6480
+ listingId: string;
6481
+ txnAt: string;
6482
+ openFrom: string;
6483
+ }[];
6484
+ } | null;
6485
+ } | null;
6486
+ }[];
6487
+ };
6488
+ };
6489
+ };
6490
+ /** @description Invalid input data */
6491
+ 400: {
6492
+ headers: {
6493
+ [name: string]: unknown;
6494
+ };
6495
+ content: {
6496
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
6497
+ };
6498
+ };
6499
+ /** @description Authorization not provided */
6500
+ 401: {
6501
+ headers: {
6502
+ [name: string]: unknown;
6503
+ };
6504
+ content: {
6505
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
6506
+ };
6507
+ };
6508
+ /** @description Insufficient access */
6509
+ 403: {
6510
+ headers: {
6511
+ [name: string]: unknown;
6512
+ };
6513
+ content: {
6514
+ "application/json": components["schemas"]["error.FORBIDDEN"];
6515
+ };
6516
+ };
6517
+ /** @description Internal server error */
6518
+ 500: {
6519
+ headers: {
6520
+ [name: string]: unknown;
6521
+ };
6522
+ content: {
6523
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
6524
+ };
6525
+ };
6526
+ };
6527
+ };
6528
+ updateReservationAdjustment: {
6529
+ parameters: {
6530
+ query?: never;
6531
+ header?: {
6532
+ "X-Team-Id"?: string;
6533
+ };
6534
+ path: {
6535
+ reservationId: string;
6536
+ id: string;
6537
+ };
6538
+ cookie?: never;
6539
+ };
6540
+ requestBody: {
6541
+ content: {
6542
+ "application/json": {
6543
+ description?: string | null;
6544
+ reservationRef?: string | null;
6545
+ /** @description Value in cents (100 = 1€) */
6546
+ amount?: number;
6547
+ accountId?: string | null;
6548
+ accountRef?: string | null;
6549
+ metadata?: {
6550
+ [key: string]: unknown;
6551
+ } | null;
6552
+ type?: string | null;
6553
+ /** Format: uuid */
6554
+ recurringFeeId?: string | null;
6555
+ /** @enum {string|null} */
6556
+ party?: "owners" | "manager" | null;
6557
+ generalLedgerPostingAt?: string | null;
6558
+ };
6559
+ };
6560
+ };
6561
+ responses: {
6562
+ /** @description Successful response */
6563
+ 200: {
6564
+ headers: {
6565
+ [name: string]: unknown;
6566
+ };
6567
+ content: {
6568
+ "application/json": {
6569
+ currency: string | null;
6570
+ uniqueRef?: string | null;
6571
+ guestName?: string | null;
6572
+ bookerName?: string | null;
6573
+ checkIn?: string | null;
6574
+ checkOut?: string | null;
6575
+ generalLedgerPostingAt?: string | null;
6576
+ bookedAt?: string | null;
6577
+ cancelledAt?: string | null;
6578
+ bookingPlatform?: string | null;
6579
+ confirmationCode?: string | null;
6580
+ pmsReferenceCode?: string | null;
6581
+ guests?: number | null;
6582
+ userdata: {
6583
+ [key: string]: unknown;
6584
+ } | null;
6585
+ metadata: {
6586
+ [key: string]: unknown;
6587
+ } | null;
6588
+ /** Format: uuid */
6589
+ id: string;
6590
+ lock?: {
6591
+ /** @enum {string} */
6592
+ status: "locked" | "unlocked";
6593
+ booksClosed?: {
6594
+ date: string;
6595
+ } | null;
6596
+ ownerStatement?: {
6597
+ ids: string[];
6598
+ } | null;
6599
+ statementPeriod?: {
6600
+ hits: {
6601
+ /** Format: uuid */
6602
+ listingId: string;
6603
+ txnAt: string;
6604
+ openFrom: string;
6605
+ }[];
6606
+ } | null;
6607
+ } | null;
6608
+ issues: ({
6609
+ /** @enum {string} */
6610
+ code: "lineNotFound";
6611
+ /** @enum {string} */
6612
+ severity: "error";
6613
+ context: {
6614
+ lineIds: string[];
6615
+ };
6616
+ message: string;
6617
+ } | {
6618
+ /** @enum {string} */
6619
+ code: "unbalancedJournalEntries";
6620
+ /** @enum {string} */
6621
+ severity: "error";
6622
+ context: {
6623
+ difference: number;
6624
+ };
6625
+ message: string;
6626
+ } | {
6627
+ /** @enum {string} */
6628
+ code: "unassignedAccount";
6629
+ /** @enum {string} */
6630
+ severity: "error";
6631
+ context: {
6632
+ accountIds: string[];
6633
+ };
6634
+ } | {
6635
+ /** @enum {string} */
6636
+ code: "priorToStartDate";
6637
+ /** @enum {string} */
6638
+ severity: "warning";
6639
+ context: {
6640
+ startDate?: string | null;
6641
+ };
6642
+ } | {
6643
+ /** @enum {string} */
6644
+ code: "inactiveListing";
6645
+ /** @enum {string} */
6646
+ severity: "warning";
6647
+ context: {
6648
+ startDate?: string | null;
6649
+ };
6650
+ } | {
6651
+ /** @enum {string} */
6652
+ code: "inactiveConnection";
6653
+ /** @enum {string} */
6654
+ severity: "warning";
6655
+ context: Record<string, never>;
6656
+ } | {
6657
+ /** @enum {string} */
6658
+ code: "guestTotalsZero";
6659
+ /** @enum {string} */
6660
+ severity: "warning";
6661
+ context: Record<string, never>;
6662
+ } | {
6663
+ /** @enum {string} */
6664
+ code: "guestTotalsMismatch";
6665
+ /** @enum {string} */
6666
+ severity: "warning";
6667
+ context: {
6668
+ difference: number;
6669
+ };
6670
+ message: string;
6671
+ })[];
6672
+ connection?: {
6673
+ /** Format: uuid */
6674
+ id: string;
6675
+ name: string;
6676
+ /** @enum {string} */
6677
+ status: "active" | "inactive";
6678
+ uniqueRef?: string | null;
6679
+ appId: string;
6680
+ } | null;
6681
+ nights?: number | null;
6682
+ /** @enum {string} */
6683
+ status: "booked" | "canceled" | "inactive";
6684
+ financials: {
6685
+ totals: {
6686
+ tax: number;
6687
+ manager: number;
6688
+ owner: number;
6689
+ reservation: number;
6690
+ expense: number;
6691
+ deposit: number;
6692
+ guest: number;
6693
+ };
6694
+ lines?: {
6695
+ name: string;
6696
+ /** @enum {string|null} */
6697
+ type?: "reservation" | "reservation_adjustment" | "reservation_adjustment_cancellation" | "reservation_fee" | "reservation_fee_adjustment" | "reservation_fee_tax" | "transaction_transfer" | "transaction_transfer_line" | "reservation_line" | "transaction_deposit" | "transaction_deposit_channelFee" | "transaction_deposit_line" | "transaction_deposit_coHost" | "transaction_deposit_merchantFee" | "transaction_deposit_vat" | "transaction_deposit_reserve" | "transaction_deposit_openingBalance" | "transaction_deposit_openingAdvance" | "transaction_deposit_refund" | "transaction_expense" | "transaction_expense_line" | "transaction_expense_markup" | "transaction_expense_markup_tax" | "transaction_expense_payment" | null;
6698
+ /** @enum {string|null} */
6699
+ party?: "owners" | "manager" | null;
6700
+ /** @enum {string} */
6701
+ status: "active" | "inactive";
6702
+ amount: number;
6703
+ /** @enum {string|null} */
6704
+ inactiveReason?: "reservationCancelled" | "referenceAccount" | "deferredRevenue" | "system" | null;
6705
+ account?: {
6706
+ id: string;
6707
+ name: string;
6708
+ uniqueRef?: string | null;
6709
+ /** @enum {string} */
6710
+ status: "active" | "inactive";
6711
+ /** @enum {string} */
6712
+ type: "ledger" | "bank" | "recurringFee" | "nonPosting";
6713
+ } | null;
6714
+ recurringFee?: {
6715
+ id: string;
6716
+ uniqueRef: string;
6717
+ name: string;
6718
+ /** @enum {string} */
6719
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6720
+ } | null;
6721
+ transaction?: {
6722
+ id: string;
6723
+ /** @enum {string} */
6724
+ status: "active" | "inactive";
6725
+ /** @description Value in cents (100 = 1€) */
6726
+ amount: number;
6727
+ account?: {
6728
+ id: string;
6729
+ name: string;
6730
+ uniqueRef?: string | null;
6731
+ /** @enum {string} */
6732
+ status: "active" | "inactive";
6733
+ } | null;
6734
+ date: string;
6735
+ description: string;
6736
+ currency: string;
6737
+ /** @enum {string} */
6738
+ type: "deposit" | "expense" | "transfer";
6739
+ contact?: {
6740
+ /** Format: uuid */
6741
+ id: string;
6742
+ name?: string | null;
6743
+ uniqueRef?: string | null;
6744
+ } | null;
6745
+ connection?: {
6746
+ /** Format: uuid */
6747
+ id: string;
6748
+ name: string;
6749
+ /** @enum {string} */
6750
+ status: "active" | "inactive";
6751
+ uniqueRef?: string | null;
6752
+ appId: string;
6753
+ } | null;
6754
+ uniqueRef?: string | null;
6755
+ recurringTemplate?: {
6756
+ id: string;
6757
+ } | null;
6758
+ } | null;
6759
+ line?: {
6760
+ id: string;
6761
+ type?: string | null;
6762
+ description?: string | null;
6763
+ } | null;
6764
+ lock?: {
6765
+ /** @enum {string} */
6766
+ status: "locked" | "unlocked";
6767
+ booksClosed?: {
6768
+ date: string;
6769
+ } | null;
6770
+ ownerStatement?: {
6771
+ ids: string[];
6772
+ } | null;
6773
+ statementPeriod?: {
6774
+ hits: {
6775
+ /** Format: uuid */
6776
+ listingId: string;
6777
+ txnAt: string;
6778
+ openFrom: string;
6779
+ }[];
6780
+ } | null;
6781
+ } | null;
6782
+ }[] | null;
6783
+ };
6784
+ listing?: {
6785
+ /** Format: uuid */
6786
+ id: string;
6787
+ name: string;
6788
+ uniqueRef?: string | null;
6789
+ } | null;
6790
+ listingConnection?: {
6791
+ /** Format: uuid */
6792
+ id: string;
6793
+ name: string;
6794
+ uniqueRef?: string | null;
6795
+ } | null;
6796
+ payment: {
6797
+ expected: number;
6798
+ received: number;
6799
+ status: ("unpaid" | "underpaid" | "overpaid" | "paid") | "coHost";
6800
+ };
6801
+ source?: {
6802
+ /** Format: uuid */
6803
+ id: string;
6804
+ type: string;
6805
+ /** @enum {string|null} */
6806
+ status?: "active" | "inactive" | null;
6807
+ } | null;
6808
+ lines: {
6809
+ /** Format: uuid */
6810
+ id: string;
6811
+ uniqueRef?: string | null;
6812
+ type: string;
6813
+ description?: string | null;
6814
+ /** @description Value in cents (100 = 1€) */
6815
+ amount: number;
6816
+ connectionId?: string | null;
6817
+ metadata?: {
6818
+ [key: string]: unknown;
6819
+ } | null;
6820
+ account?: {
6821
+ id: string;
6822
+ name: string;
6823
+ uniqueRef?: string | null;
6824
+ /** @enum {string} */
6825
+ status: "active" | "inactive";
6826
+ } | null;
6827
+ isExcluded?: boolean | null;
6828
+ }[];
6829
+ /** @description Adjustments are manually added financial lines that are not part of the booking platform */
6830
+ adjustments: {
6831
+ /** Format: uuid */
6832
+ id: string;
6833
+ description?: string | null;
6834
+ /** @description Value in cents (100 = 1€) */
6835
+ amount: number;
6836
+ metadata?: {
6837
+ [key: string]: unknown;
6838
+ } | null;
6839
+ type?: string | null;
6840
+ /** @enum {string|null} */
6841
+ party?: "owners" | "manager" | null;
6842
+ generalLedgerPostingAt?: string | null;
6843
+ account?: {
6844
+ id: string;
6845
+ name: string;
6846
+ uniqueRef?: string | null;
6847
+ /** @enum {string} */
6848
+ status: "active" | "inactive";
6849
+ } | null;
6850
+ recurringFee?: {
6851
+ id: string;
6852
+ uniqueRef: string;
6853
+ name: string;
6854
+ /** @enum {string} */
6855
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6856
+ } | null;
6857
+ lock?: {
6858
+ /** @enum {string} */
6859
+ status: "locked" | "unlocked";
6860
+ booksClosed?: {
6861
+ date: string;
6862
+ } | null;
6863
+ ownerStatement?: {
6864
+ ids: string[];
6865
+ } | null;
6866
+ statementPeriod?: {
6867
+ hits: {
6868
+ /** Format: uuid */
6869
+ listingId: string;
6870
+ txnAt: string;
6871
+ openFrom: string;
6872
+ }[];
6873
+ } | null;
6874
+ } | null;
6875
+ }[];
6876
+ };
6877
+ };
6878
+ };
6879
+ /** @description Invalid input data */
6880
+ 400: {
6881
+ headers: {
6882
+ [name: string]: unknown;
6883
+ };
6884
+ content: {
6885
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
6886
+ };
6887
+ };
6888
+ /** @description Authorization not provided */
6889
+ 401: {
6890
+ headers: {
6891
+ [name: string]: unknown;
6892
+ };
6893
+ content: {
6894
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
6895
+ };
6896
+ };
6897
+ /** @description Insufficient access */
6898
+ 403: {
6899
+ headers: {
6900
+ [name: string]: unknown;
6901
+ };
6902
+ content: {
6903
+ "application/json": components["schemas"]["error.FORBIDDEN"];
6904
+ };
6905
+ };
6906
+ /** @description Not found */
6907
+ 404: {
6908
+ headers: {
6909
+ [name: string]: unknown;
6910
+ };
6911
+ content: {
6912
+ "application/json": components["schemas"]["error.NOT_FOUND"];
6913
+ };
6914
+ };
6915
+ /** @description Internal server error */
6916
+ 500: {
6917
+ headers: {
6918
+ [name: string]: unknown;
6919
+ };
6920
+ content: {
6921
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
6922
+ };
6923
+ };
6924
+ };
6925
+ };
6926
+ deleteReservationAdjustment: {
6927
+ parameters: {
6928
+ query?: never;
6929
+ header?: {
6930
+ "X-Team-Id"?: string;
6931
+ };
6932
+ path: {
6933
+ reservationId: string;
6934
+ id: string;
6935
+ };
6936
+ cookie?: never;
6937
+ };
6938
+ requestBody?: never;
6939
+ responses: {
6940
+ /** @description Successful response */
6941
+ 200: {
6942
+ headers: {
6943
+ [name: string]: unknown;
6944
+ };
6945
+ content: {
6946
+ "application/json": {
6947
+ currency: string | null;
6948
+ uniqueRef?: string | null;
6949
+ guestName?: string | null;
6950
+ bookerName?: string | null;
6951
+ checkIn?: string | null;
6952
+ checkOut?: string | null;
6953
+ generalLedgerPostingAt?: string | null;
6954
+ bookedAt?: string | null;
6955
+ cancelledAt?: string | null;
6956
+ bookingPlatform?: string | null;
6957
+ confirmationCode?: string | null;
6958
+ pmsReferenceCode?: string | null;
6959
+ guests?: number | null;
6960
+ userdata: {
6961
+ [key: string]: unknown;
6962
+ } | null;
6963
+ metadata: {
6964
+ [key: string]: unknown;
6965
+ } | null;
6966
+ /** Format: uuid */
6967
+ id: string;
6968
+ lock?: {
6969
+ /** @enum {string} */
6970
+ status: "locked" | "unlocked";
6971
+ booksClosed?: {
6972
+ date: string;
6973
+ } | null;
6974
+ ownerStatement?: {
6975
+ ids: string[];
6976
+ } | null;
6977
+ statementPeriod?: {
6978
+ hits: {
6979
+ /** Format: uuid */
6980
+ listingId: string;
6981
+ txnAt: string;
6982
+ openFrom: string;
6983
+ }[];
6984
+ } | null;
6985
+ } | null;
6986
+ issues: ({
6987
+ /** @enum {string} */
6988
+ code: "lineNotFound";
6989
+ /** @enum {string} */
6990
+ severity: "error";
6991
+ context: {
6992
+ lineIds: string[];
6993
+ };
6994
+ message: string;
6995
+ } | {
6996
+ /** @enum {string} */
6997
+ code: "unbalancedJournalEntries";
6998
+ /** @enum {string} */
6999
+ severity: "error";
7000
+ context: {
7001
+ difference: number;
7002
+ };
7003
+ message: string;
7004
+ } | {
7005
+ /** @enum {string} */
7006
+ code: "unassignedAccount";
7007
+ /** @enum {string} */
7008
+ severity: "error";
7009
+ context: {
7010
+ accountIds: string[];
7011
+ };
7012
+ } | {
7013
+ /** @enum {string} */
7014
+ code: "priorToStartDate";
7015
+ /** @enum {string} */
7016
+ severity: "warning";
7017
+ context: {
7018
+ startDate?: string | null;
7019
+ };
7020
+ } | {
7021
+ /** @enum {string} */
7022
+ code: "inactiveListing";
7023
+ /** @enum {string} */
7024
+ severity: "warning";
7025
+ context: {
7026
+ startDate?: string | null;
7027
+ };
7028
+ } | {
7029
+ /** @enum {string} */
7030
+ code: "inactiveConnection";
7031
+ /** @enum {string} */
7032
+ severity: "warning";
7033
+ context: Record<string, never>;
7034
+ } | {
7035
+ /** @enum {string} */
7036
+ code: "guestTotalsZero";
7037
+ /** @enum {string} */
7038
+ severity: "warning";
7039
+ context: Record<string, never>;
7040
+ } | {
7041
+ /** @enum {string} */
7042
+ code: "guestTotalsMismatch";
7043
+ /** @enum {string} */
7044
+ severity: "warning";
7045
+ context: {
7046
+ difference: number;
7047
+ };
7048
+ message: string;
7049
+ })[];
7050
+ connection?: {
7051
+ /** Format: uuid */
7052
+ id: string;
7053
+ name: string;
7054
+ /** @enum {string} */
7055
+ status: "active" | "inactive";
7056
+ uniqueRef?: string | null;
7057
+ appId: string;
7058
+ } | null;
7059
+ nights?: number | null;
7060
+ /** @enum {string} */
7061
+ status: "booked" | "canceled" | "inactive";
7062
+ financials: {
7063
+ totals: {
7064
+ tax: number;
7065
+ manager: number;
7066
+ owner: number;
7067
+ reservation: number;
7068
+ expense: number;
7069
+ deposit: number;
7070
+ guest: number;
7071
+ };
7072
+ lines?: {
7073
+ name: string;
7074
+ /** @enum {string|null} */
7075
+ type?: "reservation" | "reservation_adjustment" | "reservation_adjustment_cancellation" | "reservation_fee" | "reservation_fee_adjustment" | "reservation_fee_tax" | "transaction_transfer" | "transaction_transfer_line" | "reservation_line" | "transaction_deposit" | "transaction_deposit_channelFee" | "transaction_deposit_line" | "transaction_deposit_coHost" | "transaction_deposit_merchantFee" | "transaction_deposit_vat" | "transaction_deposit_reserve" | "transaction_deposit_openingBalance" | "transaction_deposit_openingAdvance" | "transaction_deposit_refund" | "transaction_expense" | "transaction_expense_line" | "transaction_expense_markup" | "transaction_expense_markup_tax" | "transaction_expense_payment" | null;
7076
+ /** @enum {string|null} */
7077
+ party?: "owners" | "manager" | null;
7078
+ /** @enum {string} */
7079
+ status: "active" | "inactive";
7080
+ amount: number;
7081
+ /** @enum {string|null} */
7082
+ inactiveReason?: "reservationCancelled" | "referenceAccount" | "deferredRevenue" | "system" | null;
7083
+ account?: {
7084
+ id: string;
7085
+ name: string;
7086
+ uniqueRef?: string | null;
7087
+ /** @enum {string} */
7088
+ status: "active" | "inactive";
7089
+ /** @enum {string} */
7090
+ type: "ledger" | "bank" | "recurringFee" | "nonPosting";
7091
+ } | null;
7092
+ recurringFee?: {
7093
+ id: string;
7094
+ uniqueRef: string;
7095
+ name: string;
7096
+ /** @enum {string} */
7097
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7098
+ } | null;
7099
+ transaction?: {
7100
+ id: string;
7101
+ /** @enum {string} */
7102
+ status: "active" | "inactive";
7103
+ /** @description Value in cents (100 = 1€) */
7104
+ amount: number;
7105
+ account?: {
7106
+ id: string;
7107
+ name: string;
7108
+ uniqueRef?: string | null;
7109
+ /** @enum {string} */
7110
+ status: "active" | "inactive";
7111
+ } | null;
7112
+ date: string;
7113
+ description: string;
7114
+ currency: string;
7115
+ /** @enum {string} */
7116
+ type: "deposit" | "expense" | "transfer";
7117
+ contact?: {
7118
+ /** Format: uuid */
7119
+ id: string;
7120
+ name?: string | null;
7121
+ uniqueRef?: string | null;
7122
+ } | null;
7123
+ connection?: {
7124
+ /** Format: uuid */
7125
+ id: string;
7126
+ name: string;
7127
+ /** @enum {string} */
7128
+ status: "active" | "inactive";
7129
+ uniqueRef?: string | null;
7130
+ appId: string;
7131
+ } | null;
7132
+ uniqueRef?: string | null;
7133
+ recurringTemplate?: {
7134
+ id: string;
7135
+ } | null;
7136
+ } | null;
7137
+ line?: {
7138
+ id: string;
7139
+ type?: string | null;
7140
+ description?: string | null;
7141
+ } | null;
7142
+ lock?: {
7143
+ /** @enum {string} */
7144
+ status: "locked" | "unlocked";
7145
+ booksClosed?: {
7146
+ date: string;
7147
+ } | null;
7148
+ ownerStatement?: {
7149
+ ids: string[];
7150
+ } | null;
7151
+ statementPeriod?: {
7152
+ hits: {
7153
+ /** Format: uuid */
7154
+ listingId: string;
7155
+ txnAt: string;
7156
+ openFrom: string;
7157
+ }[];
7158
+ } | null;
7159
+ } | null;
7160
+ }[] | null;
7161
+ };
7162
+ listing?: {
7163
+ /** Format: uuid */
7164
+ id: string;
7165
+ name: string;
7166
+ uniqueRef?: string | null;
7167
+ } | null;
7168
+ listingConnection?: {
7169
+ /** Format: uuid */
7170
+ id: string;
7171
+ name: string;
7172
+ uniqueRef?: string | null;
7173
+ } | null;
7174
+ payment: {
7175
+ expected: number;
7176
+ received: number;
7177
+ status: ("unpaid" | "underpaid" | "overpaid" | "paid") | "coHost";
7178
+ };
7179
+ source?: {
7180
+ /** Format: uuid */
7181
+ id: string;
7182
+ type: string;
7183
+ /** @enum {string|null} */
7184
+ status?: "active" | "inactive" | null;
7185
+ } | null;
7186
+ lines: {
7187
+ /** Format: uuid */
7188
+ id: string;
7189
+ uniqueRef?: string | null;
7190
+ type: string;
7191
+ description?: string | null;
7192
+ /** @description Value in cents (100 = 1€) */
7193
+ amount: number;
7194
+ connectionId?: string | null;
7195
+ metadata?: {
7196
+ [key: string]: unknown;
7197
+ } | null;
7198
+ account?: {
7199
+ id: string;
7200
+ name: string;
7201
+ uniqueRef?: string | null;
7202
+ /** @enum {string} */
7203
+ status: "active" | "inactive";
7204
+ } | null;
7205
+ isExcluded?: boolean | null;
7206
+ }[];
7207
+ /** @description Adjustments are manually added financial lines that are not part of the booking platform */
7208
+ adjustments: {
7209
+ /** Format: uuid */
7210
+ id: string;
7211
+ description?: string | null;
7212
+ /** @description Value in cents (100 = 1€) */
7213
+ amount: number;
7214
+ metadata?: {
7215
+ [key: string]: unknown;
7216
+ } | null;
7217
+ type?: string | null;
7218
+ /** @enum {string|null} */
7219
+ party?: "owners" | "manager" | null;
7220
+ generalLedgerPostingAt?: string | null;
7221
+ account?: {
7222
+ id: string;
7223
+ name: string;
7224
+ uniqueRef?: string | null;
7225
+ /** @enum {string} */
7226
+ status: "active" | "inactive";
7227
+ } | null;
7228
+ recurringFee?: {
7229
+ id: string;
7230
+ uniqueRef: string;
7231
+ name: string;
7232
+ /** @enum {string} */
7233
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7234
+ } | null;
7235
+ lock?: {
7236
+ /** @enum {string} */
7237
+ status: "locked" | "unlocked";
7238
+ booksClosed?: {
7239
+ date: string;
7240
+ } | null;
7241
+ ownerStatement?: {
7242
+ ids: string[];
7243
+ } | null;
7244
+ statementPeriod?: {
7245
+ hits: {
7246
+ /** Format: uuid */
7247
+ listingId: string;
7248
+ txnAt: string;
7249
+ openFrom: string;
7250
+ }[];
7251
+ } | null;
7252
+ } | null;
7253
+ }[];
7254
+ };
7255
+ };
7256
+ };
7257
+ /** @description Invalid input data */
7258
+ 400: {
7259
+ headers: {
7260
+ [name: string]: unknown;
7261
+ };
7262
+ content: {
7263
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
7264
+ };
7265
+ };
7266
+ /** @description Authorization not provided */
7267
+ 401: {
7268
+ headers: {
7269
+ [name: string]: unknown;
7270
+ };
7271
+ content: {
7272
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
7273
+ };
7274
+ };
7275
+ /** @description Insufficient access */
7276
+ 403: {
7277
+ headers: {
7278
+ [name: string]: unknown;
7279
+ };
7280
+ content: {
7281
+ "application/json": components["schemas"]["error.FORBIDDEN"];
7282
+ };
7283
+ };
7284
+ /** @description Not found */
7285
+ 404: {
7286
+ headers: {
7287
+ [name: string]: unknown;
7288
+ };
7289
+ content: {
7290
+ "application/json": components["schemas"]["error.NOT_FOUND"];
7291
+ };
7292
+ };
7293
+ /** @description Internal server error */
7294
+ 500: {
7295
+ headers: {
7296
+ [name: string]: unknown;
7297
+ };
7298
+ content: {
7299
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
7300
+ };
7301
+ };
7302
+ };
7303
+ };
6104
7304
  getListingOwnerships: {
6105
7305
  parameters: {
6106
7306
  query?: {