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