@vrplatform/api 1.3.1-stage.2139 → 1.3.1-stage.2141

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.
@@ -408,7 +408,7 @@ export interface paths {
408
408
  };
409
409
  get?: never;
410
410
  put?: never;
411
- /** @description Preview an unsaved bank rule against one bank record */
411
+ /** @description Preview an unsaved bank rule against unmatched bank records it would affect */
412
412
  post: operations["postBankRulesPreview"];
413
413
  delete?: never;
414
414
  options?: never;
@@ -7169,78 +7169,13 @@ export interface operations {
7169
7169
  /** Format: uuid */
7170
7170
  id: string;
7171
7171
  name: string;
7172
- /** @enum {string} */
7173
- status: "active" | "inactive";
7174
7172
  priority: number;
7175
7173
  /** @enum {string} */
7176
7174
  transactionType: "deposit" | "expense";
7177
7175
  /** @enum {string} */
7178
7176
  mode: "suggest" | "autoCreateAndMatch";
7179
- descriptionOperator?: ("contains" | "equals" | "startsWith") | null;
7180
- descriptionValue?: string | null;
7181
- amountMinCent?: number | null;
7182
- amountMaxCent?: number | null;
7183
- descriptionOverride?: string | null;
7184
- usePriorMonthEnd: boolean;
7185
- version: number;
7186
- vendorContact?: {
7187
- /** Format: uuid */
7188
- id: string;
7189
- name?: string | null;
7190
- firstName?: string | null;
7191
- uniqueRef?: string | null;
7192
- shortRef?: string | null;
7193
- } | null;
7194
- accounts: {
7195
- id: string;
7196
- name: string;
7197
- uniqueRef?: string | null;
7198
- /** @enum {string} */
7199
- status: "active" | "inactive";
7200
- }[];
7201
- lines: {
7202
- /** Format: uuid */
7203
- id: string;
7204
- sortOrder: number;
7205
- /** @enum {string} */
7206
- splitMode: "fixed" | "percentage" | "remainder";
7207
- fixedCentAmount?: number | null;
7208
- percentageBps?: number | null;
7209
- party?: ("owners" | "manager") | null;
7210
- taxBehavior?: ("excluded" | "included") | null;
7211
- descriptionOverride?: string | null;
7212
- account: {
7213
- id: string;
7214
- name: string;
7215
- uniqueRef?: string | null;
7216
- /** @enum {string} */
7217
- status: "active" | "inactive";
7218
- };
7219
- listing?: {
7220
- /** Format: uuid */
7221
- id: string;
7222
- name: string;
7223
- uniqueRef?: string | null;
7224
- shortRef?: string | null;
7225
- } | null;
7226
- contact?: {
7227
- /** Format: uuid */
7228
- id: string;
7229
- name?: string | null;
7230
- firstName?: string | null;
7231
- uniqueRef?: string | null;
7232
- shortRef?: string | null;
7233
- } | null;
7234
- taxRate?: {
7235
- id: string;
7236
- name: string;
7237
- /**
7238
- * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
7239
- * @example 100000
7240
- */
7241
- basisPoints: number;
7242
- } | null;
7243
- }[];
7177
+ /** @enum {string} */
7178
+ status: "active" | "inactive";
7244
7179
  };
7245
7180
  preview: {
7246
7181
  matches: boolean;
@@ -7270,13 +7205,17 @@ export interface operations {
7270
7205
  uniqueRef?: string | null;
7271
7206
  description: string;
7272
7207
  accountId?: string | null;
7273
- assignment?: string | null;
7208
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
7274
7209
  amount: number;
7275
7210
  appliedAmount?: {
7276
7211
  taxRateId?: string | null;
7277
7212
  taxBehavior?: ("excluded" | "included") | null;
7278
7213
  } | null;
7279
- markup: null;
7214
+ markup?: {
7215
+ amount?: number | null;
7216
+ taxRateId?: string | null;
7217
+ taxBehavior?: ("excluded" | "included") | null;
7218
+ } | null;
7280
7219
  listingId?: string | null;
7281
7220
  reservationId?: string | null;
7282
7221
  ownerStatementId?: string | null;
@@ -7774,78 +7713,13 @@ export interface operations {
7774
7713
  /** Format: uuid */
7775
7714
  id: string;
7776
7715
  name: string;
7777
- /** @enum {string} */
7778
- status: "active" | "inactive";
7779
7716
  priority: number;
7780
7717
  /** @enum {string} */
7781
7718
  transactionType: "deposit" | "expense";
7782
7719
  /** @enum {string} */
7783
7720
  mode: "suggest" | "autoCreateAndMatch";
7784
- descriptionOperator?: ("contains" | "equals" | "startsWith") | null;
7785
- descriptionValue?: string | null;
7786
- amountMinCent?: number | null;
7787
- amountMaxCent?: number | null;
7788
- descriptionOverride?: string | null;
7789
- usePriorMonthEnd: boolean;
7790
- version: number;
7791
- vendorContact?: {
7792
- /** Format: uuid */
7793
- id: string;
7794
- name?: string | null;
7795
- firstName?: string | null;
7796
- uniqueRef?: string | null;
7797
- shortRef?: string | null;
7798
- } | null;
7799
- accounts: {
7800
- id: string;
7801
- name: string;
7802
- uniqueRef?: string | null;
7803
- /** @enum {string} */
7804
- status: "active" | "inactive";
7805
- }[];
7806
- lines: {
7807
- /** Format: uuid */
7808
- id: string;
7809
- sortOrder: number;
7810
- /** @enum {string} */
7811
- splitMode: "fixed" | "percentage" | "remainder";
7812
- fixedCentAmount?: number | null;
7813
- percentageBps?: number | null;
7814
- party?: ("owners" | "manager") | null;
7815
- taxBehavior?: ("excluded" | "included") | null;
7816
- descriptionOverride?: string | null;
7817
- account: {
7818
- id: string;
7819
- name: string;
7820
- uniqueRef?: string | null;
7821
- /** @enum {string} */
7822
- status: "active" | "inactive";
7823
- };
7824
- listing?: {
7825
- /** Format: uuid */
7826
- id: string;
7827
- name: string;
7828
- uniqueRef?: string | null;
7829
- shortRef?: string | null;
7830
- } | null;
7831
- contact?: {
7832
- /** Format: uuid */
7833
- id: string;
7834
- name?: string | null;
7835
- firstName?: string | null;
7836
- uniqueRef?: string | null;
7837
- shortRef?: string | null;
7838
- } | null;
7839
- taxRate?: {
7840
- id: string;
7841
- name: string;
7842
- /**
7843
- * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
7844
- * @example 100000
7845
- */
7846
- basisPoints: number;
7847
- } | null;
7848
- }[];
7721
+ /** @enum {string} */
7722
+ status: "active" | "inactive";
7849
7723
  };
7850
7724
  preview: {
7851
7725
  matches: boolean;
@@ -7875,13 +7749,17 @@ export interface operations {
7875
7749
  uniqueRef?: string | null;
7876
7750
  description: string;
7877
7751
  accountId?: string | null;
7878
- assignment?: string | null;
7752
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
7879
7753
  amount: number;
7880
7754
  appliedAmount?: {
7881
7755
  taxRateId?: string | null;
7882
7756
  taxBehavior?: ("excluded" | "included") | null;
7883
7757
  } | null;
7884
- markup: null;
7758
+ markup?: {
7759
+ amount?: number | null;
7760
+ taxRateId?: string | null;
7761
+ taxBehavior?: ("excluded" | "included") | null;
7762
+ } | null;
7885
7763
  listingId?: string | null;
7886
7764
  reservationId?: string | null;
7887
7765
  ownerStatementId?: string | null;
@@ -8173,16 +8051,30 @@ export interface operations {
8173
8051
  splitMode: "fixed" | "percentage" | "remainder";
8174
8052
  fixedCentAmount?: number | null;
8175
8053
  percentageBps?: number | null;
8054
+ assignment?: "deposit_merchantFee" | null;
8176
8055
  party?: ("owners" | "manager") | null;
8177
8056
  taxBehavior?: ("excluded" | "included") | null;
8178
8057
  descriptionOverride?: string | null;
8179
- account: {
8058
+ markup?: {
8059
+ amount?: number | null;
8060
+ taxBehavior?: ("excluded" | "included") | null;
8061
+ taxRate?: {
8062
+ id: string;
8063
+ name: string;
8064
+ /**
8065
+ * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
8066
+ * @example 100000
8067
+ */
8068
+ basisPoints: number;
8069
+ } | null;
8070
+ } | null;
8071
+ account?: {
8180
8072
  id: string;
8181
8073
  name: string;
8182
8074
  uniqueRef?: string | null;
8183
8075
  /** @enum {string} */
8184
8076
  status: "active" | "inactive";
8185
- };
8077
+ } | null;
8186
8078
  listing?: {
8187
8079
  /** Format: uuid */
8188
8080
  id: string;
@@ -8333,13 +8225,18 @@ export interface operations {
8333
8225
  splitMode: "fixed" | "percentage" | "remainder";
8334
8226
  fixedCentAmount?: number | null;
8335
8227
  percentageBps?: number | null;
8336
- /** Format: uuid */
8337
- accountId: string;
8228
+ accountId?: string | null;
8229
+ assignment?: "deposit_merchantFee" | null;
8338
8230
  listingId?: string | null;
8339
8231
  contactId?: string | null;
8340
8232
  party?: ("owners" | "manager") | null;
8341
8233
  taxRateId?: string | null;
8342
8234
  taxBehavior?: ("excluded" | "included") | null;
8235
+ markup?: {
8236
+ amount?: number | null;
8237
+ taxRateId?: string | null;
8238
+ taxBehavior?: ("excluded" | "included") | null;
8239
+ } | null;
8343
8240
  descriptionOverride?: string | null;
8344
8241
  }[];
8345
8242
  };
@@ -8393,16 +8290,30 @@ export interface operations {
8393
8290
  splitMode: "fixed" | "percentage" | "remainder";
8394
8291
  fixedCentAmount?: number | null;
8395
8292
  percentageBps?: number | null;
8293
+ assignment?: "deposit_merchantFee" | null;
8396
8294
  party?: ("owners" | "manager") | null;
8397
8295
  taxBehavior?: ("excluded" | "included") | null;
8398
8296
  descriptionOverride?: string | null;
8399
- account: {
8297
+ markup?: {
8298
+ amount?: number | null;
8299
+ taxBehavior?: ("excluded" | "included") | null;
8300
+ taxRate?: {
8301
+ id: string;
8302
+ name: string;
8303
+ /**
8304
+ * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
8305
+ * @example 100000
8306
+ */
8307
+ basisPoints: number;
8308
+ } | null;
8309
+ } | null;
8310
+ account?: {
8400
8311
  id: string;
8401
8312
  name: string;
8402
8313
  uniqueRef?: string | null;
8403
8314
  /** @enum {string} */
8404
8315
  status: "active" | "inactive";
8405
- };
8316
+ } | null;
8406
8317
  listing?: {
8407
8318
  /** Format: uuid */
8408
8319
  id: string;
@@ -8543,17 +8454,20 @@ export interface operations {
8543
8454
  splitMode: "fixed" | "percentage" | "remainder";
8544
8455
  fixedCentAmount?: number | null;
8545
8456
  percentageBps?: number | null;
8546
- /** Format: uuid */
8547
- accountId: string;
8457
+ accountId?: string | null;
8458
+ assignment?: "deposit_merchantFee" | null;
8548
8459
  listingId?: string | null;
8549
8460
  contactId?: string | null;
8550
8461
  party?: ("owners" | "manager") | null;
8551
8462
  taxRateId?: string | null;
8552
8463
  taxBehavior?: ("excluded" | "included") | null;
8464
+ markup?: {
8465
+ amount?: number | null;
8466
+ taxRateId?: string | null;
8467
+ taxBehavior?: ("excluded" | "included") | null;
8468
+ } | null;
8553
8469
  descriptionOverride?: string | null;
8554
8470
  }[];
8555
- /** Format: uuid */
8556
- bankRecordId: string;
8557
8471
  };
8558
8472
  };
8559
8473
  };
@@ -8565,62 +8479,68 @@ export interface operations {
8565
8479
  };
8566
8480
  content: {
8567
8481
  "application/json": {
8568
- matches: boolean;
8569
- isAutoApplicable: boolean;
8570
- bankRecord: {
8571
- /** Format: uuid */
8572
- id: string;
8573
- date: string;
8574
- description: string;
8575
- amount: number;
8576
- bankAccountId?: string | null;
8577
- accountId?: string | null;
8578
- };
8579
- transaction: {
8580
- description: string;
8581
- status?: ("active" | "inactive") | null;
8582
- accountId?: string | null;
8583
- contactId?: string | null;
8584
- uniqueRef?: string | null;
8585
- isOpeningBalance?: boolean;
8586
- /** @enum {string} */
8587
- type: "deposit" | "expense";
8588
- date: string;
8589
- currency?: string | null;
8590
- lines: {
8591
- recurringTemplateId?: string | null;
8592
- uniqueRef?: string | null;
8482
+ data: {
8483
+ matches: boolean;
8484
+ isAutoApplicable: boolean;
8485
+ bankRecord: {
8486
+ /** Format: uuid */
8487
+ id: string;
8488
+ date: string;
8593
8489
  description: string;
8594
- accountId?: string | null;
8595
- assignment?: string | null;
8596
8490
  amount: number;
8597
- appliedAmount?: {
8598
- taxRateId?: string | null;
8599
- taxBehavior?: ("excluded" | "included") | null;
8600
- } | null;
8601
- markup: null;
8602
- listingId?: string | null;
8603
- reservationId?: string | null;
8604
- ownerStatementId?: string | null;
8605
- party?: ("owners" | "manager") | null;
8491
+ bankAccountId?: string | null;
8492
+ accountId?: string | null;
8493
+ };
8494
+ transaction: {
8495
+ description: string;
8496
+ status?: ("active" | "inactive") | null;
8497
+ accountId?: string | null;
8606
8498
  contactId?: string | null;
8607
- matchReservationConfirmationCode?: string | null;
8608
- matchReservationStripeGuestRef?: string | null;
8609
- matchLineTypeClassification?: string | null;
8610
- }[];
8611
- attachmentIds?: string[] | null;
8612
- payment?: {
8613
- bankRecordIds: string[];
8499
+ uniqueRef?: string | null;
8500
+ isOpeningBalance?: boolean;
8614
8501
  /** @enum {string} */
8615
- status: "unpaid" | "underpaid" | "overpaid" | "paid";
8616
- date?: string | null;
8617
- lock: null;
8618
- } | null;
8619
- connectionId?: string | null;
8620
- sourceId?: string | null;
8621
- recurringTemplateId?: string | null;
8622
- matchBankAccountLast4?: string | null;
8623
- };
8502
+ type: "deposit" | "expense";
8503
+ date: string;
8504
+ currency?: string | null;
8505
+ lines: {
8506
+ recurringTemplateId?: string | null;
8507
+ uniqueRef?: string | null;
8508
+ description: string;
8509
+ accountId?: string | null;
8510
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
8511
+ amount: number;
8512
+ appliedAmount?: {
8513
+ taxRateId?: string | null;
8514
+ taxBehavior?: ("excluded" | "included") | null;
8515
+ } | null;
8516
+ markup?: {
8517
+ amount?: number | null;
8518
+ taxRateId?: string | null;
8519
+ taxBehavior?: ("excluded" | "included") | null;
8520
+ } | null;
8521
+ listingId?: string | null;
8522
+ reservationId?: string | null;
8523
+ ownerStatementId?: string | null;
8524
+ party?: ("owners" | "manager") | null;
8525
+ contactId?: string | null;
8526
+ matchReservationConfirmationCode?: string | null;
8527
+ matchReservationStripeGuestRef?: string | null;
8528
+ matchLineTypeClassification?: string | null;
8529
+ }[];
8530
+ attachmentIds?: string[] | null;
8531
+ payment?: {
8532
+ bankRecordIds: string[];
8533
+ /** @enum {string} */
8534
+ status: "unpaid" | "underpaid" | "overpaid" | "paid";
8535
+ date?: string | null;
8536
+ lock: null;
8537
+ } | null;
8538
+ connectionId?: string | null;
8539
+ sourceId?: string | null;
8540
+ recurringTemplateId?: string | null;
8541
+ matchBankAccountLast4?: string | null;
8542
+ };
8543
+ }[];
8624
8544
  };
8625
8545
  };
8626
8546
  };
@@ -8764,16 +8684,30 @@ export interface operations {
8764
8684
  splitMode: "fixed" | "percentage" | "remainder";
8765
8685
  fixedCentAmount?: number | null;
8766
8686
  percentageBps?: number | null;
8687
+ assignment?: "deposit_merchantFee" | null;
8767
8688
  party?: ("owners" | "manager") | null;
8768
8689
  taxBehavior?: ("excluded" | "included") | null;
8769
8690
  descriptionOverride?: string | null;
8770
- account: {
8691
+ markup?: {
8692
+ amount?: number | null;
8693
+ taxBehavior?: ("excluded" | "included") | null;
8694
+ taxRate?: {
8695
+ id: string;
8696
+ name: string;
8697
+ /**
8698
+ * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
8699
+ * @example 100000
8700
+ */
8701
+ basisPoints: number;
8702
+ } | null;
8703
+ } | null;
8704
+ account?: {
8771
8705
  id: string;
8772
8706
  name: string;
8773
8707
  uniqueRef?: string | null;
8774
8708
  /** @enum {string} */
8775
8709
  status: "active" | "inactive";
8776
- };
8710
+ } | null;
8777
8711
  listing?: {
8778
8712
  /** Format: uuid */
8779
8713
  id: string;
@@ -8917,13 +8851,18 @@ export interface operations {
8917
8851
  splitMode: "fixed" | "percentage" | "remainder";
8918
8852
  fixedCentAmount?: number | null;
8919
8853
  percentageBps?: number | null;
8920
- /** Format: uuid */
8921
- accountId: string;
8854
+ accountId?: string | null;
8855
+ assignment?: "deposit_merchantFee" | null;
8922
8856
  listingId?: string | null;
8923
8857
  contactId?: string | null;
8924
8858
  party?: ("owners" | "manager") | null;
8925
8859
  taxRateId?: string | null;
8926
8860
  taxBehavior?: ("excluded" | "included") | null;
8861
+ markup?: {
8862
+ amount?: number | null;
8863
+ taxRateId?: string | null;
8864
+ taxBehavior?: ("excluded" | "included") | null;
8865
+ } | null;
8927
8866
  descriptionOverride?: string | null;
8928
8867
  }[];
8929
8868
  };
@@ -8977,16 +8916,30 @@ export interface operations {
8977
8916
  splitMode: "fixed" | "percentage" | "remainder";
8978
8917
  fixedCentAmount?: number | null;
8979
8918
  percentageBps?: number | null;
8919
+ assignment?: "deposit_merchantFee" | null;
8980
8920
  party?: ("owners" | "manager") | null;
8981
8921
  taxBehavior?: ("excluded" | "included") | null;
8982
8922
  descriptionOverride?: string | null;
8983
- account: {
8923
+ markup?: {
8924
+ amount?: number | null;
8925
+ taxBehavior?: ("excluded" | "included") | null;
8926
+ taxRate?: {
8927
+ id: string;
8928
+ name: string;
8929
+ /**
8930
+ * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
8931
+ * @example 100000
8932
+ */
8933
+ basisPoints: number;
8934
+ } | null;
8935
+ } | null;
8936
+ account?: {
8984
8937
  id: string;
8985
8938
  name: string;
8986
8939
  uniqueRef?: string | null;
8987
8940
  /** @enum {string} */
8988
8941
  status: "active" | "inactive";
8989
- };
8942
+ } | null;
8990
8943
  listing?: {
8991
8944
  /** Format: uuid */
8992
8945
  id: string;
@@ -9266,13 +9219,17 @@ export interface operations {
9266
9219
  uniqueRef?: string | null;
9267
9220
  description: string;
9268
9221
  accountId?: string | null;
9269
- assignment?: string | null;
9222
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
9270
9223
  amount: number;
9271
9224
  appliedAmount?: {
9272
9225
  taxRateId?: string | null;
9273
9226
  taxBehavior?: ("excluded" | "included") | null;
9274
9227
  } | null;
9275
- markup: null;
9228
+ markup?: {
9229
+ amount?: number | null;
9230
+ taxRateId?: string | null;
9231
+ taxBehavior?: ("excluded" | "included") | null;
9232
+ } | null;
9276
9233
  listingId?: string | null;
9277
9234
  reservationId?: string | null;
9278
9235
  ownerStatementId?: string | null;