@vrplatform/api 1.3.1-stage.4987 → 1.3.1-stage.4990

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.
@@ -1090,6 +1090,27 @@ export interface paths {
1090
1090
  patch?: never;
1091
1091
  trace?: never;
1092
1092
  };
1093
+ "/contacts/{id}/payment-methods/ach": {
1094
+ parameters: {
1095
+ query?: never;
1096
+ header?: never;
1097
+ path?: never;
1098
+ cookie?: never;
1099
+ };
1100
+ get?: never;
1101
+ put?: never;
1102
+ /**
1103
+ * @description Send owner ACH details to Ramp for verification. Raw routing and account numbers are write-only and are never stored by VRPlatform. The contact becomes ready only after Ramp confirms the account.
1104
+ *
1105
+ * Required scope: contacts:write
1106
+ */
1107
+ post: operations["postContactsByIdPaymentMethodsAch"];
1108
+ delete?: never;
1109
+ options?: never;
1110
+ head?: never;
1111
+ patch?: never;
1112
+ trace?: never;
1113
+ };
1093
1114
  "/contacts/{id}/revoke-access": {
1094
1115
  parameters: {
1095
1116
  query?: never;
@@ -4672,6 +4693,48 @@ export interface paths {
4672
4693
  patch?: never;
4673
4694
  trace?: never;
4674
4695
  };
4696
+ "/statements/pay": {
4697
+ parameters: {
4698
+ query?: never;
4699
+ header?: never;
4700
+ path?: never;
4701
+ cookie?: never;
4702
+ };
4703
+ get?: never;
4704
+ put?: never;
4705
+ /**
4706
+ * @description Request selected Ramp owner payouts. Each statement succeeds or is skipped independently, so one blocked selection never rolls back successful requests. Only first payouts are supported: statements that already have a payout are skipped, and additional partial payments go through POST /statements/{id}/pay. An explicit amount overrides the full net income and therefore requires exactly one selection.
4707
+ *
4708
+ * Required scope: statements:pay
4709
+ */
4710
+ post: operations["postStatementsPay"];
4711
+ delete?: never;
4712
+ options?: never;
4713
+ head?: never;
4714
+ patch?: never;
4715
+ trace?: never;
4716
+ };
4717
+ "/statements/pay/preview": {
4718
+ parameters: {
4719
+ query?: never;
4720
+ header?: never;
4721
+ path?: never;
4722
+ cookie?: never;
4723
+ };
4724
+ get?: never;
4725
+ put?: never;
4726
+ /**
4727
+ * @description Preview Ramp payout readiness per statement, owner, connection, and funding account without creating transactions.
4728
+ *
4729
+ * Required scope: statements:read
4730
+ */
4731
+ post: operations["postStatementsPayPreview"];
4732
+ delete?: never;
4733
+ options?: never;
4734
+ head?: never;
4735
+ patch?: never;
4736
+ trace?: never;
4737
+ };
4675
4738
  "/statements/pdf": {
4676
4739
  parameters: {
4677
4740
  query?: never;
@@ -4776,7 +4839,7 @@ export interface paths {
4776
4839
  get?: never;
4777
4840
  put?: never;
4778
4841
  /**
4779
- * @description Pay an owner statement. Creates one payout transfer transaction per ownership member, split by ownership percentage, with each line referencing the paid statement; the resulting journal entries post on the payout date and are consumed by the statement of that month. Omitting amount pays the full net income and is rejected with 409 if an active payout already exists for the statement; pass an explicit amount to record additional partial payments. Payout creation respects books-closed and statement-period locks and supports dryRun. See https://docs.vrplatform.app/guides/build/statements#pay-a-published-statement.
4842
+ * @description Create owner payout transactions and optionally dispatch them through Ramp. The response includes every payout transaction ID and the durable Ramp sync ID.
4780
4843
  *
4781
4844
  * Required scope: statements:pay
4782
4845
  */
@@ -5677,7 +5740,7 @@ export interface paths {
5677
5740
  get?: never;
5678
5741
  put?: never;
5679
5742
  /**
5680
- * @description Pay a vendor bill
5743
+ * @description Record an expense as paid manually, or request a Ramp ACH payment for an expense or payout. A terminal provider failure can be retried against the existing transaction.
5681
5744
  *
5682
5745
  * Required scope: transactions:pay
5683
5746
  */
@@ -5688,6 +5751,48 @@ export interface paths {
5688
5751
  patch?: never;
5689
5752
  trace?: never;
5690
5753
  };
5754
+ "/transactions/{id}/provider-payments": {
5755
+ parameters: {
5756
+ query?: never;
5757
+ header?: never;
5758
+ path?: never;
5759
+ cookie?: never;
5760
+ };
5761
+ /**
5762
+ * @description List Ramp payment attempts for a transaction, newest attempt first.
5763
+ *
5764
+ * Required scope: transactions:read
5765
+ */
5766
+ get: operations["getTransactionsByIdProviderPayments"];
5767
+ put?: never;
5768
+ post?: never;
5769
+ delete?: never;
5770
+ options?: never;
5771
+ head?: never;
5772
+ patch?: never;
5773
+ trace?: never;
5774
+ };
5775
+ "/transactions/{id}/provider-payments/{providerPaymentId}": {
5776
+ parameters: {
5777
+ query?: never;
5778
+ header?: never;
5779
+ path?: never;
5780
+ cookie?: never;
5781
+ };
5782
+ get?: never;
5783
+ put?: never;
5784
+ post?: never;
5785
+ /**
5786
+ * @description Unlink a never-submitted or terminal Ramp payment attempt from a transaction. Processing and paid payments cannot be unlinked.
5787
+ *
5788
+ * Required scope: transactions:pay
5789
+ */
5790
+ delete: operations["deleteTransactionsByIdProviderPaymentsByProviderPaymentId"];
5791
+ options?: never;
5792
+ head?: never;
5793
+ patch?: never;
5794
+ trace?: never;
5795
+ };
5691
5796
  "/transactions/{transactionId}/lines/{id}": {
5692
5797
  parameters: {
5693
5798
  query?: never;
@@ -5934,7 +6039,14 @@ export interface operations {
5934
6039
  uniqueRef?: string | null;
5935
6040
  appId: string;
5936
6041
  icon?: string | null;
6042
+ type: string | null;
5937
6043
  } | null;
6044
+ capabilities: {
6045
+ achPayments: {
6046
+ enabled: boolean;
6047
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
6048
+ };
6049
+ };
5938
6050
  source?: {
5939
6051
  /** Format: uuid */
5940
6052
  id: string;
@@ -6498,6 +6610,22 @@ export interface operations {
6498
6610
  /** @enum {string} */
6499
6611
  status: "active" | "inactive";
6500
6612
  } | null;
6613
+ connection: {
6614
+ /** Format: uuid */
6615
+ id: string;
6616
+ name: string;
6617
+ /** @enum {string} */
6618
+ status: "active" | "inactive";
6619
+ uniqueRef?: string | null;
6620
+ appId: string;
6621
+ type: string | null;
6622
+ } | null;
6623
+ capabilities: {
6624
+ achPayments: {
6625
+ enabled: boolean;
6626
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
6627
+ };
6628
+ };
6501
6629
  source?: {
6502
6630
  /** Format: uuid */
6503
6631
  id: string;
@@ -6794,6 +6922,22 @@ export interface operations {
6794
6922
  /** @enum {string} */
6795
6923
  status: "active" | "inactive";
6796
6924
  } | null;
6925
+ connection: {
6926
+ /** Format: uuid */
6927
+ id: string;
6928
+ name: string;
6929
+ /** @enum {string} */
6930
+ status: "active" | "inactive";
6931
+ uniqueRef?: string | null;
6932
+ appId: string;
6933
+ type: string | null;
6934
+ } | null;
6935
+ capabilities: {
6936
+ achPayments: {
6937
+ enabled: boolean;
6938
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
6939
+ };
6940
+ };
6797
6941
  source?: {
6798
6942
  /** Format: uuid */
6799
6943
  id: string;
@@ -7106,6 +7250,12 @@ export interface operations {
7106
7250
  bankingCategory: "operating";
7107
7251
  };
7108
7252
  })[];
7253
+ capabilities: {
7254
+ achPayments: {
7255
+ enabled: boolean;
7256
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
7257
+ };
7258
+ };
7109
7259
  banking?: {
7110
7260
  category?: ("trust" | "operating" | "external") | null;
7111
7261
  type?: ("deposit" | "creditCard") | null;
@@ -7115,6 +7265,12 @@ export interface operations {
7115
7265
  id: string;
7116
7266
  name: string;
7117
7267
  startDate?: string | null;
7268
+ capabilities: {
7269
+ achPayments: {
7270
+ enabled: boolean;
7271
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
7272
+ };
7273
+ };
7118
7274
  connection?: {
7119
7275
  id: string;
7120
7276
  appId: string;
@@ -7123,6 +7279,7 @@ export interface operations {
7123
7279
  status: "active" | "inactive";
7124
7280
  isErrorState: boolean;
7125
7281
  icon?: string | null;
7282
+ type: string | null;
7126
7283
  } | null;
7127
7284
  status?: ("active" | "inactive") | null;
7128
7285
  currentSync?: {
@@ -7488,6 +7645,12 @@ export interface operations {
7488
7645
  bankingCategory: "operating";
7489
7646
  };
7490
7647
  })[];
7648
+ capabilities: {
7649
+ achPayments: {
7650
+ enabled: boolean;
7651
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
7652
+ };
7653
+ };
7491
7654
  banking?: {
7492
7655
  category?: ("trust" | "operating" | "external") | null;
7493
7656
  type?: ("deposit" | "creditCard") | null;
@@ -7497,6 +7660,12 @@ export interface operations {
7497
7660
  id: string;
7498
7661
  name: string;
7499
7662
  startDate?: string | null;
7663
+ capabilities: {
7664
+ achPayments: {
7665
+ enabled: boolean;
7666
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
7667
+ };
7668
+ };
7500
7669
  connection?: {
7501
7670
  id: string;
7502
7671
  appId: string;
@@ -7505,6 +7674,7 @@ export interface operations {
7505
7674
  status: "active" | "inactive";
7506
7675
  isErrorState: boolean;
7507
7676
  icon?: string | null;
7677
+ type: string | null;
7508
7678
  } | null;
7509
7679
  status?: ("active" | "inactive") | null;
7510
7680
  currentSync?: {
@@ -8345,6 +8515,12 @@ export interface operations {
8345
8515
  bankingCategory: "operating";
8346
8516
  };
8347
8517
  })[];
8518
+ capabilities: {
8519
+ achPayments: {
8520
+ enabled: boolean;
8521
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
8522
+ };
8523
+ };
8348
8524
  banking?: {
8349
8525
  category?: ("trust" | "operating" | "external") | null;
8350
8526
  type?: ("deposit" | "creditCard") | null;
@@ -8354,6 +8530,12 @@ export interface operations {
8354
8530
  id: string;
8355
8531
  name: string;
8356
8532
  startDate?: string | null;
8533
+ capabilities: {
8534
+ achPayments: {
8535
+ enabled: boolean;
8536
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
8537
+ };
8538
+ };
8357
8539
  connection?: {
8358
8540
  id: string;
8359
8541
  appId: string;
@@ -8362,6 +8544,7 @@ export interface operations {
8362
8544
  status: "active" | "inactive";
8363
8545
  isErrorState: boolean;
8364
8546
  icon?: string | null;
8547
+ type: string | null;
8365
8548
  } | null;
8366
8549
  status?: ("active" | "inactive") | null;
8367
8550
  currentSync?: {
@@ -8719,6 +8902,12 @@ export interface operations {
8719
8902
  bankingCategory: "operating";
8720
8903
  };
8721
8904
  })[];
8905
+ capabilities: {
8906
+ achPayments: {
8907
+ enabled: boolean;
8908
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
8909
+ };
8910
+ };
8722
8911
  banking?: {
8723
8912
  category?: ("trust" | "operating" | "external") | null;
8724
8913
  type?: ("deposit" | "creditCard") | null;
@@ -8728,6 +8917,12 @@ export interface operations {
8728
8917
  id: string;
8729
8918
  name: string;
8730
8919
  startDate?: string | null;
8920
+ capabilities: {
8921
+ achPayments: {
8922
+ enabled: boolean;
8923
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
8924
+ };
8925
+ };
8731
8926
  connection?: {
8732
8927
  id: string;
8733
8928
  appId: string;
@@ -8736,6 +8931,7 @@ export interface operations {
8736
8931
  status: "active" | "inactive";
8737
8932
  isErrorState: boolean;
8738
8933
  icon?: string | null;
8934
+ type: string | null;
8739
8935
  } | null;
8740
8936
  status?: ("active" | "inactive") | null;
8741
8937
  currentSync?: {
@@ -9940,6 +10136,12 @@ export interface operations {
9940
10136
  bankingCategory: "operating";
9941
10137
  };
9942
10138
  })[];
10139
+ capabilities: {
10140
+ achPayments: {
10141
+ enabled: boolean;
10142
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
10143
+ };
10144
+ };
9943
10145
  banking?: {
9944
10146
  category?: ("trust" | "operating" | "external") | null;
9945
10147
  type?: ("deposit" | "creditCard") | null;
@@ -9949,6 +10151,12 @@ export interface operations {
9949
10151
  id: string;
9950
10152
  name: string;
9951
10153
  startDate?: string | null;
10154
+ capabilities: {
10155
+ achPayments: {
10156
+ enabled: boolean;
10157
+ disabledReasons: ("unsupportedProvider" | "connectionInactive" | "accountInactive" | "unsupportedAccountType" | "missingAccountReference" | "missingAccountConnection")[];
10158
+ };
10159
+ };
9952
10160
  connection?: {
9953
10161
  id: string;
9954
10162
  appId: string;
@@ -9957,6 +10165,7 @@ export interface operations {
9957
10165
  status: "active" | "inactive";
9958
10166
  isErrorState: boolean;
9959
10167
  icon?: string | null;
10168
+ type: string | null;
9960
10169
  } | null;
9961
10170
  status?: ("active" | "inactive") | null;
9962
10171
  currentSync?: {
@@ -24600,6 +24809,16 @@ export interface operations {
24600
24809
  ownerStatementPublished: boolean;
24601
24810
  };
24602
24811
  } | null;
24812
+ paymentMethods: {
24813
+ ach: {
24814
+ /** @constant */
24815
+ provider: "ramp";
24816
+ connectionId: string | null;
24817
+ last4: string | null;
24818
+ /** @enum {string} */
24819
+ status: "notConfigured" | "pending" | "ready" | "failed";
24820
+ };
24821
+ };
24603
24822
  }[];
24604
24823
  pagination: {
24605
24824
  /** @default 100 */
@@ -25815,6 +26034,16 @@ export interface operations {
25815
26034
  ownerStatementPublished: boolean;
25816
26035
  };
25817
26036
  } | null;
26037
+ paymentMethods: {
26038
+ ach: {
26039
+ /** @constant */
26040
+ provider: "ramp";
26041
+ connectionId: string | null;
26042
+ last4: string | null;
26043
+ /** @enum {string} */
26044
+ status: "notConfigured" | "pending" | "ready" | "failed";
26045
+ };
26046
+ };
25818
26047
  };
25819
26048
  };
25820
26049
  };
@@ -26900,9 +27129,12 @@ export interface operations {
26900
27129
  };
26901
27130
  };
26902
27131
  };
26903
- postContactsByIdRevokeAccess: {
27132
+ postContactsByIdPaymentMethodsAch: {
26904
27133
  parameters: {
26905
- query?: never;
27134
+ query?: {
27135
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
27136
+ dryRun?: boolean;
27137
+ };
26906
27138
  header?: never;
26907
27139
  path: {
26908
27140
  id: string;
@@ -26911,7 +27143,15 @@ export interface operations {
26911
27143
  };
26912
27144
  requestBody?: {
26913
27145
  content: {
26914
- "application/json": Record<string, never>;
27146
+ "application/json": {
27147
+ /** @constant */
27148
+ provider: "ramp";
27149
+ /** Format: uuid */
27150
+ connectionId: string;
27151
+ legalName: string;
27152
+ routingNumber: string;
27153
+ accountNumber: string;
27154
+ };
26915
27155
  };
26916
27156
  };
26917
27157
  responses: {
@@ -26922,8 +27162,17 @@ export interface operations {
26922
27162
  };
26923
27163
  content: {
26924
27164
  "application/json": {
26925
- deletedAccess: number;
26926
- deletedUsers: number;
27165
+ /** Format: uuid */
27166
+ contactId: string;
27167
+ /** @constant */
27168
+ provider: "ramp";
27169
+ /** Format: uuid */
27170
+ connectionId: string;
27171
+ last4: string;
27172
+ /** @constant */
27173
+ status: "pending";
27174
+ /** Format: uuid */
27175
+ syncId: string;
26927
27176
  };
26928
27177
  };
26929
27178
  };
@@ -27154,7 +27403,7 @@ export interface operations {
27154
27403
  };
27155
27404
  };
27156
27405
  };
27157
- getContactsByIdViewers: {
27406
+ postContactsByIdRevokeAccess: {
27158
27407
  parameters: {
27159
27408
  query?: never;
27160
27409
  header?: never;
@@ -27163,7 +27412,11 @@ export interface operations {
27163
27412
  };
27164
27413
  cookie?: never;
27165
27414
  };
27166
- requestBody?: never;
27415
+ requestBody?: {
27416
+ content: {
27417
+ "application/json": Record<string, never>;
27418
+ };
27419
+ };
27167
27420
  responses: {
27168
27421
  /** @description Successful response */
27169
27422
  200: {
@@ -27172,20 +27425,8 @@ export interface operations {
27172
27425
  };
27173
27426
  content: {
27174
27427
  "application/json": {
27175
- data: {
27176
- /** Format: uuid */
27177
- userId: string;
27178
- email: string;
27179
- firstName: string | null;
27180
- lastName: string | null;
27181
- /** @enum {string} */
27182
- status: "active" | "inactive" | "unconfirmed";
27183
- lastInvitedAt: string | null;
27184
- lastSeen: string | null;
27185
- notifications: {
27186
- ownerStatementPublished: boolean;
27187
- };
27188
- }[];
27428
+ deletedAccess: number;
27429
+ deletedUsers: number;
27189
27430
  };
27190
27431
  };
27191
27432
  };
@@ -27416,7 +27657,7 @@ export interface operations {
27416
27657
  };
27417
27658
  };
27418
27659
  };
27419
- postContactsByIdViewers: {
27660
+ getContactsByIdViewers: {
27420
27661
  parameters: {
27421
27662
  query?: never;
27422
27663
  header?: never;
@@ -27425,15 +27666,7 @@ export interface operations {
27425
27666
  };
27426
27667
  cookie?: never;
27427
27668
  };
27428
- requestBody?: {
27429
- content: {
27430
- "application/json": {
27431
- email: string;
27432
- /** @default true */
27433
- sendEmail?: boolean;
27434
- };
27435
- };
27436
- };
27669
+ requestBody?: never;
27437
27670
  responses: {
27438
27671
  /** @description Successful response */
27439
27672
  200: {
@@ -27442,8 +27675,7 @@ export interface operations {
27442
27675
  };
27443
27676
  content: {
27444
27677
  "application/json": {
27445
- url: string;
27446
- viewer: {
27678
+ data: {
27447
27679
  /** Format: uuid */
27448
27680
  userId: string;
27449
27681
  email: string;
@@ -27456,7 +27688,7 @@ export interface operations {
27456
27688
  notifications: {
27457
27689
  ownerStatementPublished: boolean;
27458
27690
  };
27459
- };
27691
+ }[];
27460
27692
  };
27461
27693
  };
27462
27694
  };
@@ -27687,17 +27919,24 @@ export interface operations {
27687
27919
  };
27688
27920
  };
27689
27921
  };
27690
- deleteContactsByIdViewersByUserId: {
27922
+ postContactsByIdViewers: {
27691
27923
  parameters: {
27692
27924
  query?: never;
27693
27925
  header?: never;
27694
27926
  path: {
27695
27927
  id: string;
27696
- userId: string;
27697
27928
  };
27698
27929
  cookie?: never;
27699
27930
  };
27700
- requestBody?: never;
27931
+ requestBody?: {
27932
+ content: {
27933
+ "application/json": {
27934
+ email: string;
27935
+ /** @default true */
27936
+ sendEmail?: boolean;
27937
+ };
27938
+ };
27939
+ };
27701
27940
  responses: {
27702
27941
  /** @description Successful response */
27703
27942
  200: {
@@ -27706,8 +27945,21 @@ export interface operations {
27706
27945
  };
27707
27946
  content: {
27708
27947
  "application/json": {
27709
- /** @constant */
27710
- status: "deleted";
27948
+ url: string;
27949
+ viewer: {
27950
+ /** Format: uuid */
27951
+ userId: string;
27952
+ email: string;
27953
+ firstName: string | null;
27954
+ lastName: string | null;
27955
+ /** @enum {string} */
27956
+ status: "active" | "inactive" | "unconfirmed";
27957
+ lastInvitedAt: string | null;
27958
+ lastSeen: string | null;
27959
+ notifications: {
27960
+ ownerStatementPublished: boolean;
27961
+ };
27962
+ };
27711
27963
  };
27712
27964
  };
27713
27965
  };
@@ -27938,7 +28190,7 @@ export interface operations {
27938
28190
  };
27939
28191
  };
27940
28192
  };
27941
- postContactsByIdViewersByUserIdReinvite: {
28193
+ deleteContactsByIdViewersByUserId: {
27942
28194
  parameters: {
27943
28195
  query?: never;
27944
28196
  header?: never;
@@ -27948,14 +28200,7 @@ export interface operations {
27948
28200
  };
27949
28201
  cookie?: never;
27950
28202
  };
27951
- requestBody?: {
27952
- content: {
27953
- "application/json": {
27954
- /** @default true */
27955
- sendEmail?: boolean;
27956
- };
27957
- };
27958
- };
28203
+ requestBody?: never;
27959
28204
  responses: {
27960
28205
  /** @description Successful response */
27961
28206
  200: {
@@ -27964,21 +28209,279 @@ export interface operations {
27964
28209
  };
27965
28210
  content: {
27966
28211
  "application/json": {
27967
- url: string;
27968
- viewer: {
27969
- /** Format: uuid */
27970
- userId: string;
27971
- email: string;
27972
- firstName: string | null;
27973
- lastName: string | null;
27974
- /** @enum {string} */
27975
- status: "active" | "inactive" | "unconfirmed";
27976
- lastInvitedAt: string | null;
27977
- lastSeen: string | null;
27978
- notifications: {
27979
- ownerStatementPublished: boolean;
27980
- };
27981
- };
28212
+ /** @constant */
28213
+ status: "deleted";
28214
+ };
28215
+ };
28216
+ };
28217
+ /** @description Bad request */
28218
+ 400: {
28219
+ headers: {
28220
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28221
+ "Retry-After"?: number;
28222
+ [name: string]: unknown;
28223
+ };
28224
+ content: {
28225
+ "application/json": {
28226
+ code: string;
28227
+ message: string;
28228
+ links?: {
28229
+ docs: string;
28230
+ schema: string;
28231
+ };
28232
+ issues?: {
28233
+ message: string;
28234
+ path?: (string | number)[];
28235
+ schema?: string;
28236
+ }[];
28237
+ retryable?: boolean;
28238
+ context?: unknown;
28239
+ };
28240
+ };
28241
+ };
28242
+ /** @description Unauthorized */
28243
+ 401: {
28244
+ headers: {
28245
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28246
+ "Retry-After"?: number;
28247
+ [name: string]: unknown;
28248
+ };
28249
+ content: {
28250
+ "application/json": {
28251
+ code: string;
28252
+ message: string;
28253
+ links?: {
28254
+ docs: string;
28255
+ schema: string;
28256
+ };
28257
+ issues?: {
28258
+ message: string;
28259
+ path?: (string | number)[];
28260
+ schema?: string;
28261
+ }[];
28262
+ retryable?: boolean;
28263
+ context?: unknown;
28264
+ };
28265
+ };
28266
+ };
28267
+ /** @description Forbidden */
28268
+ 403: {
28269
+ headers: {
28270
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28271
+ "Retry-After"?: number;
28272
+ [name: string]: unknown;
28273
+ };
28274
+ content: {
28275
+ "application/json": {
28276
+ code: string;
28277
+ message: string;
28278
+ links?: {
28279
+ docs: string;
28280
+ schema: string;
28281
+ };
28282
+ issues?: {
28283
+ message: string;
28284
+ path?: (string | number)[];
28285
+ schema?: string;
28286
+ }[];
28287
+ retryable?: boolean;
28288
+ context?: unknown;
28289
+ };
28290
+ };
28291
+ };
28292
+ /** @description Not found */
28293
+ 404: {
28294
+ headers: {
28295
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28296
+ "Retry-After"?: number;
28297
+ [name: string]: unknown;
28298
+ };
28299
+ content: {
28300
+ "application/json": {
28301
+ code: string;
28302
+ message: string;
28303
+ links?: {
28304
+ docs: string;
28305
+ schema: string;
28306
+ };
28307
+ issues?: {
28308
+ message: string;
28309
+ path?: (string | number)[];
28310
+ schema?: string;
28311
+ }[];
28312
+ retryable?: boolean;
28313
+ context?: unknown;
28314
+ };
28315
+ };
28316
+ };
28317
+ /** @description Conflict */
28318
+ 409: {
28319
+ headers: {
28320
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28321
+ "Retry-After"?: number;
28322
+ [name: string]: unknown;
28323
+ };
28324
+ content: {
28325
+ "application/json": {
28326
+ code: string;
28327
+ message: string;
28328
+ links?: {
28329
+ docs: string;
28330
+ schema: string;
28331
+ };
28332
+ issues?: {
28333
+ message: string;
28334
+ path?: (string | number)[];
28335
+ schema?: string;
28336
+ }[];
28337
+ retryable?: boolean;
28338
+ context?: unknown;
28339
+ };
28340
+ };
28341
+ };
28342
+ /** @description Gone */
28343
+ 410: {
28344
+ headers: {
28345
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28346
+ "Retry-After"?: number;
28347
+ [name: string]: unknown;
28348
+ };
28349
+ content: {
28350
+ "application/json": {
28351
+ code: string;
28352
+ message: string;
28353
+ links?: {
28354
+ docs: string;
28355
+ schema: string;
28356
+ };
28357
+ issues?: {
28358
+ message: string;
28359
+ path?: (string | number)[];
28360
+ schema?: string;
28361
+ }[];
28362
+ retryable?: boolean;
28363
+ context?: unknown;
28364
+ };
28365
+ };
28366
+ };
28367
+ /** @description Unprocessable content */
28368
+ 422: {
28369
+ headers: {
28370
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28371
+ "Retry-After"?: number;
28372
+ [name: string]: unknown;
28373
+ };
28374
+ content: {
28375
+ "application/json": {
28376
+ code: string;
28377
+ message: string;
28378
+ links?: {
28379
+ docs: string;
28380
+ schema: string;
28381
+ };
28382
+ issues?: {
28383
+ message: string;
28384
+ path?: (string | number)[];
28385
+ schema?: string;
28386
+ }[];
28387
+ retryable?: boolean;
28388
+ context?: unknown;
28389
+ };
28390
+ };
28391
+ };
28392
+ /** @description Internal server error */
28393
+ 500: {
28394
+ headers: {
28395
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28396
+ "Retry-After"?: number;
28397
+ [name: string]: unknown;
28398
+ };
28399
+ content: {
28400
+ "application/json": {
28401
+ code: string;
28402
+ message: string;
28403
+ links?: {
28404
+ docs: string;
28405
+ schema: string;
28406
+ };
28407
+ issues?: {
28408
+ message: string;
28409
+ path?: (string | number)[];
28410
+ schema?: string;
28411
+ }[];
28412
+ retryable?: boolean;
28413
+ context?: unknown;
28414
+ };
28415
+ };
28416
+ };
28417
+ /** @description Service unavailable */
28418
+ 503: {
28419
+ headers: {
28420
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28421
+ "Retry-After"?: number;
28422
+ [name: string]: unknown;
28423
+ };
28424
+ content: {
28425
+ "application/json": {
28426
+ code: string;
28427
+ message: string;
28428
+ links?: {
28429
+ docs: string;
28430
+ schema: string;
28431
+ };
28432
+ issues?: {
28433
+ message: string;
28434
+ path?: (string | number)[];
28435
+ schema?: string;
28436
+ }[];
28437
+ retryable?: boolean;
28438
+ context?: unknown;
28439
+ };
28440
+ };
28441
+ };
28442
+ };
28443
+ };
28444
+ postContactsByIdViewersByUserIdReinvite: {
28445
+ parameters: {
28446
+ query?: never;
28447
+ header?: never;
28448
+ path: {
28449
+ id: string;
28450
+ userId: string;
28451
+ };
28452
+ cookie?: never;
28453
+ };
28454
+ requestBody?: {
28455
+ content: {
28456
+ "application/json": {
28457
+ /** @default true */
28458
+ sendEmail?: boolean;
28459
+ };
28460
+ };
28461
+ };
28462
+ responses: {
28463
+ /** @description Successful response */
28464
+ 200: {
28465
+ headers: {
28466
+ [name: string]: unknown;
28467
+ };
28468
+ content: {
28469
+ "application/json": {
28470
+ url: string;
28471
+ viewer: {
28472
+ /** Format: uuid */
28473
+ userId: string;
28474
+ email: string;
28475
+ firstName: string | null;
28476
+ lastName: string | null;
28477
+ /** @enum {string} */
28478
+ status: "active" | "inactive" | "unconfirmed";
28479
+ lastInvitedAt: string | null;
28480
+ lastSeen: string | null;
28481
+ notifications: {
28482
+ ownerStatementPublished: boolean;
28483
+ };
28484
+ };
27982
28485
  };
27983
28486
  };
27984
28487
  };
@@ -92976,6 +93479,35 @@ export interface operations {
92976
93479
  date: string;
92977
93480
  total: number;
92978
93481
  totalFormatted: string;
93482
+ providerPayment: {
93483
+ /** Format: uuid */
93484
+ id: string;
93485
+ /** @constant */
93486
+ provider: "ramp";
93487
+ /** Format: uuid */
93488
+ connectionId: string;
93489
+ /** Format: uuid */
93490
+ transactionId: string;
93491
+ syncId: string | null;
93492
+ /** @enum {string} */
93493
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
93494
+ externalRef: string | null;
93495
+ failureReason: string | null;
93496
+ attemptId: string;
93497
+ attempt: number;
93498
+ /**
93499
+ * Format: date-time
93500
+ * @description Timestamp string with date, time, milliseconds, and timezone.
93501
+ * @example 2024-01-15T12:30:00.000+00:00
93502
+ */
93503
+ createdAt: string;
93504
+ /**
93505
+ * Format: date-time
93506
+ * @description Timestamp string with date, time, milliseconds, and timezone.
93507
+ * @example 2024-01-15T12:30:00.000+00:00
93508
+ */
93509
+ updatedAt: string;
93510
+ } | null;
92979
93511
  }[];
92980
93512
  source?: {
92981
93513
  /** Format: uuid */
@@ -95156,6 +95688,35 @@ export interface operations {
95156
95688
  date: string;
95157
95689
  total: number;
95158
95690
  totalFormatted: string;
95691
+ providerPayment: {
95692
+ /** Format: uuid */
95693
+ id: string;
95694
+ /** @constant */
95695
+ provider: "ramp";
95696
+ /** Format: uuid */
95697
+ connectionId: string;
95698
+ /** Format: uuid */
95699
+ transactionId: string;
95700
+ syncId: string | null;
95701
+ /** @enum {string} */
95702
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
95703
+ externalRef: string | null;
95704
+ failureReason: string | null;
95705
+ attemptId: string;
95706
+ attempt: number;
95707
+ /**
95708
+ * Format: date-time
95709
+ * @description Timestamp string with date, time, milliseconds, and timezone.
95710
+ * @example 2024-01-15T12:30:00.000+00:00
95711
+ */
95712
+ createdAt: string;
95713
+ /**
95714
+ * Format: date-time
95715
+ * @description Timestamp string with date, time, milliseconds, and timezone.
95716
+ * @example 2024-01-15T12:30:00.000+00:00
95717
+ */
95718
+ updatedAt: string;
95719
+ } | null;
95159
95720
  }[];
95160
95721
  source?: {
95161
95722
  /** Format: uuid */
@@ -100685,285 +101246,34 @@ export interface operations {
100685
101246
  };
100686
101247
  };
100687
101248
  };
100688
- getStatementsPdf: {
101249
+ postStatementsPay: {
100689
101250
  parameters: {
100690
- query: {
100691
- viewAs?: "owner" | "manager";
100692
- ownershipPeriodId: string;
100693
- /** @description Month string in format `YYYY-MM`. */
100694
- month: string;
100695
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
100696
- currency?: string;
100697
- contactId?: string;
101251
+ query?: {
101252
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
101253
+ dryRun?: boolean;
100698
101254
  };
100699
101255
  header?: never;
100700
101256
  path?: never;
100701
101257
  cookie?: never;
100702
101258
  };
100703
- requestBody?: never;
100704
- responses: {
100705
- /** @description Successful response */
100706
- 200: {
100707
- headers: {
100708
- [name: string]: unknown;
100709
- };
100710
- content: {
100711
- "application/json": {
100712
- data: {
100713
- url: string;
100714
- contactId: string;
100715
- expIn: number;
100716
- }[];
100717
- };
100718
- };
100719
- };
100720
- /** @description Bad request */
100721
- 400: {
100722
- headers: {
100723
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100724
- "Retry-After"?: number;
100725
- [name: string]: unknown;
100726
- };
100727
- content: {
100728
- "application/json": {
100729
- code: string;
100730
- message: string;
100731
- links?: {
100732
- docs: string;
100733
- schema: string;
100734
- };
100735
- issues?: {
100736
- message: string;
100737
- path?: (string | number)[];
100738
- schema?: string;
100739
- }[];
100740
- retryable?: boolean;
100741
- context?: unknown;
100742
- };
100743
- };
100744
- };
100745
- /** @description Unauthorized */
100746
- 401: {
100747
- headers: {
100748
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100749
- "Retry-After"?: number;
100750
- [name: string]: unknown;
100751
- };
100752
- content: {
100753
- "application/json": {
100754
- code: string;
100755
- message: string;
100756
- links?: {
100757
- docs: string;
100758
- schema: string;
100759
- };
100760
- issues?: {
100761
- message: string;
100762
- path?: (string | number)[];
100763
- schema?: string;
100764
- }[];
100765
- retryable?: boolean;
100766
- context?: unknown;
100767
- };
100768
- };
100769
- };
100770
- /** @description Forbidden */
100771
- 403: {
100772
- headers: {
100773
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100774
- "Retry-After"?: number;
100775
- [name: string]: unknown;
100776
- };
100777
- content: {
100778
- "application/json": {
100779
- code: string;
100780
- message: string;
100781
- links?: {
100782
- docs: string;
100783
- schema: string;
100784
- };
100785
- issues?: {
100786
- message: string;
100787
- path?: (string | number)[];
100788
- schema?: string;
100789
- }[];
100790
- retryable?: boolean;
100791
- context?: unknown;
100792
- };
100793
- };
100794
- };
100795
- /** @description Not found */
100796
- 404: {
100797
- headers: {
100798
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100799
- "Retry-After"?: number;
100800
- [name: string]: unknown;
100801
- };
100802
- content: {
100803
- "application/json": {
100804
- code: string;
100805
- message: string;
100806
- links?: {
100807
- docs: string;
100808
- schema: string;
100809
- };
100810
- issues?: {
100811
- message: string;
100812
- path?: (string | number)[];
100813
- schema?: string;
100814
- }[];
100815
- retryable?: boolean;
100816
- context?: unknown;
100817
- };
100818
- };
100819
- };
100820
- /** @description Conflict */
100821
- 409: {
100822
- headers: {
100823
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100824
- "Retry-After"?: number;
100825
- [name: string]: unknown;
100826
- };
100827
- content: {
100828
- "application/json": {
100829
- code: string;
100830
- message: string;
100831
- links?: {
100832
- docs: string;
100833
- schema: string;
100834
- };
100835
- issues?: {
100836
- message: string;
100837
- path?: (string | number)[];
100838
- schema?: string;
100839
- }[];
100840
- retryable?: boolean;
100841
- context?: unknown;
100842
- };
100843
- };
100844
- };
100845
- /** @description Gone */
100846
- 410: {
100847
- headers: {
100848
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100849
- "Retry-After"?: number;
100850
- [name: string]: unknown;
100851
- };
100852
- content: {
100853
- "application/json": {
100854
- code: string;
100855
- message: string;
100856
- links?: {
100857
- docs: string;
100858
- schema: string;
100859
- };
100860
- issues?: {
100861
- message: string;
100862
- path?: (string | number)[];
100863
- schema?: string;
100864
- }[];
100865
- retryable?: boolean;
100866
- context?: unknown;
100867
- };
100868
- };
100869
- };
100870
- /** @description Unprocessable content */
100871
- 422: {
100872
- headers: {
100873
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100874
- "Retry-After"?: number;
100875
- [name: string]: unknown;
100876
- };
100877
- content: {
100878
- "application/json": {
100879
- code: string;
100880
- message: string;
100881
- links?: {
100882
- docs: string;
100883
- schema: string;
100884
- };
100885
- issues?: {
100886
- message: string;
100887
- path?: (string | number)[];
100888
- schema?: string;
100889
- }[];
100890
- retryable?: boolean;
100891
- context?: unknown;
100892
- };
100893
- };
100894
- };
100895
- /** @description Internal server error */
100896
- 500: {
100897
- headers: {
100898
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100899
- "Retry-After"?: number;
100900
- [name: string]: unknown;
100901
- };
100902
- content: {
100903
- "application/json": {
100904
- code: string;
100905
- message: string;
100906
- links?: {
100907
- docs: string;
100908
- schema: string;
100909
- };
100910
- issues?: {
100911
- message: string;
100912
- path?: (string | number)[];
100913
- schema?: string;
100914
- }[];
100915
- retryable?: boolean;
100916
- context?: unknown;
100917
- };
100918
- };
100919
- };
100920
- /** @description Service unavailable */
100921
- 503: {
100922
- headers: {
100923
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
100924
- "Retry-After"?: number;
100925
- [name: string]: unknown;
100926
- };
100927
- content: {
100928
- "application/json": {
100929
- code: string;
100930
- message: string;
100931
- links?: {
100932
- docs: string;
100933
- schema: string;
100934
- };
100935
- issues?: {
100936
- message: string;
100937
- path?: (string | number)[];
100938
- schema?: string;
100939
- }[];
100940
- retryable?: boolean;
100941
- context?: unknown;
100942
- };
101259
+ requestBody?: {
101260
+ content: {
101261
+ "application/json": {
101262
+ /** @constant */
101263
+ provider: "ramp";
101264
+ selections: {
101265
+ /** Format: uuid */
101266
+ statementId: string;
101267
+ /** Format: uuid */
101268
+ fundingAccountId?: string;
101269
+ idempotencyKey?: string;
101270
+ }[];
101271
+ date?: string | null;
101272
+ amount?: number | null;
101273
+ bankAccountId?: string | null;
100943
101274
  };
100944
101275
  };
100945
101276
  };
100946
- };
100947
- getStatementsPdfBatch: {
100948
- parameters: {
100949
- query?: {
100950
- /** @description comma separated ownership periods */
100951
- ownershipPeriodIds?: string;
100952
- /** @description Month string in format `YYYY-MM`. */
100953
- month?: string;
100954
- listingId?: string;
100955
- /** @description Month string in format `YYYY-MM`. */
100956
- startMonth?: string;
100957
- /** @description Month string in format `YYYY-MM`. */
100958
- endMonth?: string;
100959
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
100960
- currency?: string;
100961
- };
100962
- header?: never;
100963
- path?: never;
100964
- cookie?: never;
100965
- };
100966
- requestBody?: never;
100967
101277
  responses: {
100968
101278
  /** @description Successful response */
100969
101279
  200: {
@@ -100972,8 +101282,816 @@ export interface operations {
100972
101282
  };
100973
101283
  content: {
100974
101284
  "application/json": {
100975
- url: string;
100976
- expIn: number;
101285
+ results: {
101286
+ /** Format: uuid */
101287
+ statementId: string;
101288
+ /** @enum {string} */
101289
+ status: "requested" | "skipped";
101290
+ transactionIds: string[];
101291
+ syncId: string | null;
101292
+ message: string | null;
101293
+ }[];
101294
+ };
101295
+ };
101296
+ };
101297
+ /** @description Bad request */
101298
+ 400: {
101299
+ headers: {
101300
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101301
+ "Retry-After"?: number;
101302
+ [name: string]: unknown;
101303
+ };
101304
+ content: {
101305
+ "application/json": {
101306
+ code: string;
101307
+ message: string;
101308
+ links?: {
101309
+ docs: string;
101310
+ schema: string;
101311
+ };
101312
+ issues?: {
101313
+ message: string;
101314
+ path?: (string | number)[];
101315
+ schema?: string;
101316
+ }[];
101317
+ retryable?: boolean;
101318
+ context?: unknown;
101319
+ };
101320
+ };
101321
+ };
101322
+ /** @description Unauthorized */
101323
+ 401: {
101324
+ headers: {
101325
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101326
+ "Retry-After"?: number;
101327
+ [name: string]: unknown;
101328
+ };
101329
+ content: {
101330
+ "application/json": {
101331
+ code: string;
101332
+ message: string;
101333
+ links?: {
101334
+ docs: string;
101335
+ schema: string;
101336
+ };
101337
+ issues?: {
101338
+ message: string;
101339
+ path?: (string | number)[];
101340
+ schema?: string;
101341
+ }[];
101342
+ retryable?: boolean;
101343
+ context?: unknown;
101344
+ };
101345
+ };
101346
+ };
101347
+ /** @description Forbidden */
101348
+ 403: {
101349
+ headers: {
101350
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101351
+ "Retry-After"?: number;
101352
+ [name: string]: unknown;
101353
+ };
101354
+ content: {
101355
+ "application/json": {
101356
+ code: string;
101357
+ message: string;
101358
+ links?: {
101359
+ docs: string;
101360
+ schema: string;
101361
+ };
101362
+ issues?: {
101363
+ message: string;
101364
+ path?: (string | number)[];
101365
+ schema?: string;
101366
+ }[];
101367
+ retryable?: boolean;
101368
+ context?: unknown;
101369
+ };
101370
+ };
101371
+ };
101372
+ /** @description Not found */
101373
+ 404: {
101374
+ headers: {
101375
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101376
+ "Retry-After"?: number;
101377
+ [name: string]: unknown;
101378
+ };
101379
+ content: {
101380
+ "application/json": {
101381
+ code: string;
101382
+ message: string;
101383
+ links?: {
101384
+ docs: string;
101385
+ schema: string;
101386
+ };
101387
+ issues?: {
101388
+ message: string;
101389
+ path?: (string | number)[];
101390
+ schema?: string;
101391
+ }[];
101392
+ retryable?: boolean;
101393
+ context?: unknown;
101394
+ };
101395
+ };
101396
+ };
101397
+ /** @description Conflict */
101398
+ 409: {
101399
+ headers: {
101400
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101401
+ "Retry-After"?: number;
101402
+ [name: string]: unknown;
101403
+ };
101404
+ content: {
101405
+ "application/json": {
101406
+ code: string;
101407
+ message: string;
101408
+ links?: {
101409
+ docs: string;
101410
+ schema: string;
101411
+ };
101412
+ issues?: {
101413
+ message: string;
101414
+ path?: (string | number)[];
101415
+ schema?: string;
101416
+ }[];
101417
+ retryable?: boolean;
101418
+ context?: unknown;
101419
+ };
101420
+ };
101421
+ };
101422
+ /** @description Gone */
101423
+ 410: {
101424
+ headers: {
101425
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101426
+ "Retry-After"?: number;
101427
+ [name: string]: unknown;
101428
+ };
101429
+ content: {
101430
+ "application/json": {
101431
+ code: string;
101432
+ message: string;
101433
+ links?: {
101434
+ docs: string;
101435
+ schema: string;
101436
+ };
101437
+ issues?: {
101438
+ message: string;
101439
+ path?: (string | number)[];
101440
+ schema?: string;
101441
+ }[];
101442
+ retryable?: boolean;
101443
+ context?: unknown;
101444
+ };
101445
+ };
101446
+ };
101447
+ /** @description Unprocessable content */
101448
+ 422: {
101449
+ headers: {
101450
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101451
+ "Retry-After"?: number;
101452
+ [name: string]: unknown;
101453
+ };
101454
+ content: {
101455
+ "application/json": {
101456
+ code: string;
101457
+ message: string;
101458
+ links?: {
101459
+ docs: string;
101460
+ schema: string;
101461
+ };
101462
+ issues?: {
101463
+ message: string;
101464
+ path?: (string | number)[];
101465
+ schema?: string;
101466
+ }[];
101467
+ retryable?: boolean;
101468
+ context?: unknown;
101469
+ };
101470
+ };
101471
+ };
101472
+ /** @description Internal server error */
101473
+ 500: {
101474
+ headers: {
101475
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101476
+ "Retry-After"?: number;
101477
+ [name: string]: unknown;
101478
+ };
101479
+ content: {
101480
+ "application/json": {
101481
+ code: string;
101482
+ message: string;
101483
+ links?: {
101484
+ docs: string;
101485
+ schema: string;
101486
+ };
101487
+ issues?: {
101488
+ message: string;
101489
+ path?: (string | number)[];
101490
+ schema?: string;
101491
+ }[];
101492
+ retryable?: boolean;
101493
+ context?: unknown;
101494
+ };
101495
+ };
101496
+ };
101497
+ /** @description Service unavailable */
101498
+ 503: {
101499
+ headers: {
101500
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101501
+ "Retry-After"?: number;
101502
+ [name: string]: unknown;
101503
+ };
101504
+ content: {
101505
+ "application/json": {
101506
+ code: string;
101507
+ message: string;
101508
+ links?: {
101509
+ docs: string;
101510
+ schema: string;
101511
+ };
101512
+ issues?: {
101513
+ message: string;
101514
+ path?: (string | number)[];
101515
+ schema?: string;
101516
+ }[];
101517
+ retryable?: boolean;
101518
+ context?: unknown;
101519
+ };
101520
+ };
101521
+ };
101522
+ };
101523
+ };
101524
+ postStatementsPayPreview: {
101525
+ parameters: {
101526
+ query?: never;
101527
+ header?: never;
101528
+ path?: never;
101529
+ cookie?: never;
101530
+ };
101531
+ requestBody?: {
101532
+ content: {
101533
+ "application/json": {
101534
+ statementIds: string[];
101535
+ /** Format: uuid */
101536
+ connectionId?: string;
101537
+ /** Format: uuid */
101538
+ fundingAccountId?: string;
101539
+ };
101540
+ };
101541
+ };
101542
+ responses: {
101543
+ /** @description Successful response */
101544
+ 200: {
101545
+ headers: {
101546
+ [name: string]: unknown;
101547
+ };
101548
+ content: {
101549
+ "application/json": {
101550
+ data: {
101551
+ /** Format: uuid */
101552
+ statementId: string;
101553
+ ready: boolean;
101554
+ connectionId: string | null;
101555
+ fundingAccountId: string | null;
101556
+ owners: {
101557
+ contactId: string | null;
101558
+ paymentMethod: {
101559
+ /** @constant */
101560
+ provider: "ramp";
101561
+ connectionId: string | null;
101562
+ last4: string | null;
101563
+ /** @enum {string} */
101564
+ status: "notConfigured" | "pending" | "ready" | "failed";
101565
+ } | null;
101566
+ ready: boolean;
101567
+ }[];
101568
+ issues: {
101569
+ /** @enum {string} */
101570
+ code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "fundingAccountNotFound" | "fundingAccountUnavailable" | "ownerMissing" | "ownerPaymentMethodNotReady";
101571
+ message: string;
101572
+ /** Format: uuid */
101573
+ contactId?: string;
101574
+ }[];
101575
+ }[];
101576
+ };
101577
+ };
101578
+ };
101579
+ /** @description Bad request */
101580
+ 400: {
101581
+ headers: {
101582
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101583
+ "Retry-After"?: number;
101584
+ [name: string]: unknown;
101585
+ };
101586
+ content: {
101587
+ "application/json": {
101588
+ code: string;
101589
+ message: string;
101590
+ links?: {
101591
+ docs: string;
101592
+ schema: string;
101593
+ };
101594
+ issues?: {
101595
+ message: string;
101596
+ path?: (string | number)[];
101597
+ schema?: string;
101598
+ }[];
101599
+ retryable?: boolean;
101600
+ context?: unknown;
101601
+ };
101602
+ };
101603
+ };
101604
+ /** @description Unauthorized */
101605
+ 401: {
101606
+ headers: {
101607
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101608
+ "Retry-After"?: number;
101609
+ [name: string]: unknown;
101610
+ };
101611
+ content: {
101612
+ "application/json": {
101613
+ code: string;
101614
+ message: string;
101615
+ links?: {
101616
+ docs: string;
101617
+ schema: string;
101618
+ };
101619
+ issues?: {
101620
+ message: string;
101621
+ path?: (string | number)[];
101622
+ schema?: string;
101623
+ }[];
101624
+ retryable?: boolean;
101625
+ context?: unknown;
101626
+ };
101627
+ };
101628
+ };
101629
+ /** @description Forbidden */
101630
+ 403: {
101631
+ headers: {
101632
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101633
+ "Retry-After"?: number;
101634
+ [name: string]: unknown;
101635
+ };
101636
+ content: {
101637
+ "application/json": {
101638
+ code: string;
101639
+ message: string;
101640
+ links?: {
101641
+ docs: string;
101642
+ schema: string;
101643
+ };
101644
+ issues?: {
101645
+ message: string;
101646
+ path?: (string | number)[];
101647
+ schema?: string;
101648
+ }[];
101649
+ retryable?: boolean;
101650
+ context?: unknown;
101651
+ };
101652
+ };
101653
+ };
101654
+ /** @description Not found */
101655
+ 404: {
101656
+ headers: {
101657
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101658
+ "Retry-After"?: number;
101659
+ [name: string]: unknown;
101660
+ };
101661
+ content: {
101662
+ "application/json": {
101663
+ code: string;
101664
+ message: string;
101665
+ links?: {
101666
+ docs: string;
101667
+ schema: string;
101668
+ };
101669
+ issues?: {
101670
+ message: string;
101671
+ path?: (string | number)[];
101672
+ schema?: string;
101673
+ }[];
101674
+ retryable?: boolean;
101675
+ context?: unknown;
101676
+ };
101677
+ };
101678
+ };
101679
+ /** @description Conflict */
101680
+ 409: {
101681
+ headers: {
101682
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101683
+ "Retry-After"?: number;
101684
+ [name: string]: unknown;
101685
+ };
101686
+ content: {
101687
+ "application/json": {
101688
+ code: string;
101689
+ message: string;
101690
+ links?: {
101691
+ docs: string;
101692
+ schema: string;
101693
+ };
101694
+ issues?: {
101695
+ message: string;
101696
+ path?: (string | number)[];
101697
+ schema?: string;
101698
+ }[];
101699
+ retryable?: boolean;
101700
+ context?: unknown;
101701
+ };
101702
+ };
101703
+ };
101704
+ /** @description Gone */
101705
+ 410: {
101706
+ headers: {
101707
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101708
+ "Retry-After"?: number;
101709
+ [name: string]: unknown;
101710
+ };
101711
+ content: {
101712
+ "application/json": {
101713
+ code: string;
101714
+ message: string;
101715
+ links?: {
101716
+ docs: string;
101717
+ schema: string;
101718
+ };
101719
+ issues?: {
101720
+ message: string;
101721
+ path?: (string | number)[];
101722
+ schema?: string;
101723
+ }[];
101724
+ retryable?: boolean;
101725
+ context?: unknown;
101726
+ };
101727
+ };
101728
+ };
101729
+ /** @description Unprocessable content */
101730
+ 422: {
101731
+ headers: {
101732
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101733
+ "Retry-After"?: number;
101734
+ [name: string]: unknown;
101735
+ };
101736
+ content: {
101737
+ "application/json": {
101738
+ code: string;
101739
+ message: string;
101740
+ links?: {
101741
+ docs: string;
101742
+ schema: string;
101743
+ };
101744
+ issues?: {
101745
+ message: string;
101746
+ path?: (string | number)[];
101747
+ schema?: string;
101748
+ }[];
101749
+ retryable?: boolean;
101750
+ context?: unknown;
101751
+ };
101752
+ };
101753
+ };
101754
+ /** @description Internal server error */
101755
+ 500: {
101756
+ headers: {
101757
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101758
+ "Retry-After"?: number;
101759
+ [name: string]: unknown;
101760
+ };
101761
+ content: {
101762
+ "application/json": {
101763
+ code: string;
101764
+ message: string;
101765
+ links?: {
101766
+ docs: string;
101767
+ schema: string;
101768
+ };
101769
+ issues?: {
101770
+ message: string;
101771
+ path?: (string | number)[];
101772
+ schema?: string;
101773
+ }[];
101774
+ retryable?: boolean;
101775
+ context?: unknown;
101776
+ };
101777
+ };
101778
+ };
101779
+ /** @description Service unavailable */
101780
+ 503: {
101781
+ headers: {
101782
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101783
+ "Retry-After"?: number;
101784
+ [name: string]: unknown;
101785
+ };
101786
+ content: {
101787
+ "application/json": {
101788
+ code: string;
101789
+ message: string;
101790
+ links?: {
101791
+ docs: string;
101792
+ schema: string;
101793
+ };
101794
+ issues?: {
101795
+ message: string;
101796
+ path?: (string | number)[];
101797
+ schema?: string;
101798
+ }[];
101799
+ retryable?: boolean;
101800
+ context?: unknown;
101801
+ };
101802
+ };
101803
+ };
101804
+ };
101805
+ };
101806
+ getStatementsPdf: {
101807
+ parameters: {
101808
+ query: {
101809
+ viewAs?: "owner" | "manager";
101810
+ ownershipPeriodId: string;
101811
+ /** @description Month string in format `YYYY-MM`. */
101812
+ month: string;
101813
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
101814
+ currency?: string;
101815
+ contactId?: string;
101816
+ };
101817
+ header?: never;
101818
+ path?: never;
101819
+ cookie?: never;
101820
+ };
101821
+ requestBody?: never;
101822
+ responses: {
101823
+ /** @description Successful response */
101824
+ 200: {
101825
+ headers: {
101826
+ [name: string]: unknown;
101827
+ };
101828
+ content: {
101829
+ "application/json": {
101830
+ data: {
101831
+ url: string;
101832
+ contactId: string;
101833
+ expIn: number;
101834
+ }[];
101835
+ };
101836
+ };
101837
+ };
101838
+ /** @description Bad request */
101839
+ 400: {
101840
+ headers: {
101841
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101842
+ "Retry-After"?: number;
101843
+ [name: string]: unknown;
101844
+ };
101845
+ content: {
101846
+ "application/json": {
101847
+ code: string;
101848
+ message: string;
101849
+ links?: {
101850
+ docs: string;
101851
+ schema: string;
101852
+ };
101853
+ issues?: {
101854
+ message: string;
101855
+ path?: (string | number)[];
101856
+ schema?: string;
101857
+ }[];
101858
+ retryable?: boolean;
101859
+ context?: unknown;
101860
+ };
101861
+ };
101862
+ };
101863
+ /** @description Unauthorized */
101864
+ 401: {
101865
+ headers: {
101866
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101867
+ "Retry-After"?: number;
101868
+ [name: string]: unknown;
101869
+ };
101870
+ content: {
101871
+ "application/json": {
101872
+ code: string;
101873
+ message: string;
101874
+ links?: {
101875
+ docs: string;
101876
+ schema: string;
101877
+ };
101878
+ issues?: {
101879
+ message: string;
101880
+ path?: (string | number)[];
101881
+ schema?: string;
101882
+ }[];
101883
+ retryable?: boolean;
101884
+ context?: unknown;
101885
+ };
101886
+ };
101887
+ };
101888
+ /** @description Forbidden */
101889
+ 403: {
101890
+ headers: {
101891
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101892
+ "Retry-After"?: number;
101893
+ [name: string]: unknown;
101894
+ };
101895
+ content: {
101896
+ "application/json": {
101897
+ code: string;
101898
+ message: string;
101899
+ links?: {
101900
+ docs: string;
101901
+ schema: string;
101902
+ };
101903
+ issues?: {
101904
+ message: string;
101905
+ path?: (string | number)[];
101906
+ schema?: string;
101907
+ }[];
101908
+ retryable?: boolean;
101909
+ context?: unknown;
101910
+ };
101911
+ };
101912
+ };
101913
+ /** @description Not found */
101914
+ 404: {
101915
+ headers: {
101916
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101917
+ "Retry-After"?: number;
101918
+ [name: string]: unknown;
101919
+ };
101920
+ content: {
101921
+ "application/json": {
101922
+ code: string;
101923
+ message: string;
101924
+ links?: {
101925
+ docs: string;
101926
+ schema: string;
101927
+ };
101928
+ issues?: {
101929
+ message: string;
101930
+ path?: (string | number)[];
101931
+ schema?: string;
101932
+ }[];
101933
+ retryable?: boolean;
101934
+ context?: unknown;
101935
+ };
101936
+ };
101937
+ };
101938
+ /** @description Conflict */
101939
+ 409: {
101940
+ headers: {
101941
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101942
+ "Retry-After"?: number;
101943
+ [name: string]: unknown;
101944
+ };
101945
+ content: {
101946
+ "application/json": {
101947
+ code: string;
101948
+ message: string;
101949
+ links?: {
101950
+ docs: string;
101951
+ schema: string;
101952
+ };
101953
+ issues?: {
101954
+ message: string;
101955
+ path?: (string | number)[];
101956
+ schema?: string;
101957
+ }[];
101958
+ retryable?: boolean;
101959
+ context?: unknown;
101960
+ };
101961
+ };
101962
+ };
101963
+ /** @description Gone */
101964
+ 410: {
101965
+ headers: {
101966
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101967
+ "Retry-After"?: number;
101968
+ [name: string]: unknown;
101969
+ };
101970
+ content: {
101971
+ "application/json": {
101972
+ code: string;
101973
+ message: string;
101974
+ links?: {
101975
+ docs: string;
101976
+ schema: string;
101977
+ };
101978
+ issues?: {
101979
+ message: string;
101980
+ path?: (string | number)[];
101981
+ schema?: string;
101982
+ }[];
101983
+ retryable?: boolean;
101984
+ context?: unknown;
101985
+ };
101986
+ };
101987
+ };
101988
+ /** @description Unprocessable content */
101989
+ 422: {
101990
+ headers: {
101991
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
101992
+ "Retry-After"?: number;
101993
+ [name: string]: unknown;
101994
+ };
101995
+ content: {
101996
+ "application/json": {
101997
+ code: string;
101998
+ message: string;
101999
+ links?: {
102000
+ docs: string;
102001
+ schema: string;
102002
+ };
102003
+ issues?: {
102004
+ message: string;
102005
+ path?: (string | number)[];
102006
+ schema?: string;
102007
+ }[];
102008
+ retryable?: boolean;
102009
+ context?: unknown;
102010
+ };
102011
+ };
102012
+ };
102013
+ /** @description Internal server error */
102014
+ 500: {
102015
+ headers: {
102016
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
102017
+ "Retry-After"?: number;
102018
+ [name: string]: unknown;
102019
+ };
102020
+ content: {
102021
+ "application/json": {
102022
+ code: string;
102023
+ message: string;
102024
+ links?: {
102025
+ docs: string;
102026
+ schema: string;
102027
+ };
102028
+ issues?: {
102029
+ message: string;
102030
+ path?: (string | number)[];
102031
+ schema?: string;
102032
+ }[];
102033
+ retryable?: boolean;
102034
+ context?: unknown;
102035
+ };
102036
+ };
102037
+ };
102038
+ /** @description Service unavailable */
102039
+ 503: {
102040
+ headers: {
102041
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
102042
+ "Retry-After"?: number;
102043
+ [name: string]: unknown;
102044
+ };
102045
+ content: {
102046
+ "application/json": {
102047
+ code: string;
102048
+ message: string;
102049
+ links?: {
102050
+ docs: string;
102051
+ schema: string;
102052
+ };
102053
+ issues?: {
102054
+ message: string;
102055
+ path?: (string | number)[];
102056
+ schema?: string;
102057
+ }[];
102058
+ retryable?: boolean;
102059
+ context?: unknown;
102060
+ };
102061
+ };
102062
+ };
102063
+ };
102064
+ };
102065
+ getStatementsPdfBatch: {
102066
+ parameters: {
102067
+ query?: {
102068
+ /** @description comma separated ownership periods */
102069
+ ownershipPeriodIds?: string;
102070
+ /** @description Month string in format `YYYY-MM`. */
102071
+ month?: string;
102072
+ listingId?: string;
102073
+ /** @description Month string in format `YYYY-MM`. */
102074
+ startMonth?: string;
102075
+ /** @description Month string in format `YYYY-MM`. */
102076
+ endMonth?: string;
102077
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
102078
+ currency?: string;
102079
+ };
102080
+ header?: never;
102081
+ path?: never;
102082
+ cookie?: never;
102083
+ };
102084
+ requestBody?: never;
102085
+ responses: {
102086
+ /** @description Successful response */
102087
+ 200: {
102088
+ headers: {
102089
+ [name: string]: unknown;
102090
+ };
102091
+ content: {
102092
+ "application/json": {
102093
+ url: string;
102094
+ expIn: number;
100977
102095
  };
100978
102096
  };
100979
102097
  };
@@ -101827,6 +102945,35 @@ export interface operations {
101827
102945
  date: string;
101828
102946
  total: number;
101829
102947
  totalFormatted: string;
102948
+ providerPayment: {
102949
+ /** Format: uuid */
102950
+ id: string;
102951
+ /** @constant */
102952
+ provider: "ramp";
102953
+ /** Format: uuid */
102954
+ connectionId: string;
102955
+ /** Format: uuid */
102956
+ transactionId: string;
102957
+ syncId: string | null;
102958
+ /** @enum {string} */
102959
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
102960
+ externalRef: string | null;
102961
+ failureReason: string | null;
102962
+ attemptId: string;
102963
+ attempt: number;
102964
+ /**
102965
+ * Format: date-time
102966
+ * @description Timestamp string with date, time, milliseconds, and timezone.
102967
+ * @example 2024-01-15T12:30:00.000+00:00
102968
+ */
102969
+ createdAt: string;
102970
+ /**
102971
+ * Format: date-time
102972
+ * @description Timestamp string with date, time, milliseconds, and timezone.
102973
+ * @example 2024-01-15T12:30:00.000+00:00
102974
+ */
102975
+ updatedAt: string;
102976
+ } | null;
101830
102977
  }[];
101831
102978
  source?: {
101832
102979
  /** Format: uuid */
@@ -104792,15 +105939,12 @@ export interface operations {
104792
105939
  requestBody?: {
104793
105940
  content: {
104794
105941
  "application/json": {
104795
- ramp: boolean;
105942
+ provider: "ramp" | null;
104796
105943
  date?: string | null;
104797
105944
  amount?: number | null;
104798
105945
  bankAccountId?: string | null;
104799
- owner?: {
104800
- legalName?: string;
104801
- accountNumber?: string;
104802
- routingNumber?: string;
104803
- };
105946
+ fundingAccountId?: string | null;
105947
+ idempotencyKey?: string;
104804
105948
  };
104805
105949
  };
104806
105950
  };
@@ -104812,12 +105956,14 @@ export interface operations {
104812
105956
  };
104813
105957
  content: {
104814
105958
  "application/json": {
104815
- data: {
105959
+ payouts: {
104816
105960
  /** Format: uuid */
104817
105961
  id: string;
104818
105962
  uniqueRef?: string | null;
104819
105963
  sourceId?: string | null;
104820
105964
  }[];
105965
+ transactionIds: string[];
105966
+ syncId: string | null;
104821
105967
  };
104822
105968
  };
104823
105969
  };
@@ -116641,6 +117787,35 @@ export interface operations {
116641
117787
  } | null;
116642
117788
  matchStatus?: string | null;
116643
117789
  matchedByBankRule: boolean;
117790
+ providerPayment: {
117791
+ /** Format: uuid */
117792
+ id: string;
117793
+ /** @constant */
117794
+ provider: "ramp";
117795
+ /** Format: uuid */
117796
+ connectionId: string;
117797
+ /** Format: uuid */
117798
+ transactionId: string;
117799
+ syncId: string | null;
117800
+ /** @enum {string} */
117801
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
117802
+ externalRef: string | null;
117803
+ failureReason: string | null;
117804
+ attemptId: string;
117805
+ attempt: number;
117806
+ /**
117807
+ * Format: date-time
117808
+ * @description Timestamp string with date, time, milliseconds, and timezone.
117809
+ * @example 2024-01-15T12:30:00.000+00:00
117810
+ */
117811
+ createdAt: string;
117812
+ /**
117813
+ * Format: date-time
117814
+ * @description Timestamp string with date, time, milliseconds, and timezone.
117815
+ * @example 2024-01-15T12:30:00.000+00:00
117816
+ */
117817
+ updatedAt: string;
117818
+ } | null;
116644
117819
  }[];
116645
117820
  pagination: {
116646
117821
  /** @default 100 */
@@ -122920,9 +124095,576 @@ export interface operations {
122920
124095
  appId?: string | null;
122921
124096
  appIcon?: string | null;
122922
124097
  } | null;
122923
- matchStatus?: string | null;
122924
- matchedByBankRule: boolean;
122925
- }[];
124098
+ matchStatus?: string | null;
124099
+ matchedByBankRule: boolean;
124100
+ }[];
124101
+ };
124102
+ };
124103
+ };
124104
+ /** @description Bad request */
124105
+ 400: {
124106
+ headers: {
124107
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124108
+ "Retry-After"?: number;
124109
+ [name: string]: unknown;
124110
+ };
124111
+ content: {
124112
+ "application/json": {
124113
+ code: string;
124114
+ message: string;
124115
+ links?: {
124116
+ docs: string;
124117
+ schema: string;
124118
+ };
124119
+ issues?: {
124120
+ message: string;
124121
+ path?: (string | number)[];
124122
+ schema?: string;
124123
+ }[];
124124
+ retryable?: boolean;
124125
+ context?: unknown;
124126
+ };
124127
+ };
124128
+ };
124129
+ /** @description Unauthorized */
124130
+ 401: {
124131
+ headers: {
124132
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124133
+ "Retry-After"?: number;
124134
+ [name: string]: unknown;
124135
+ };
124136
+ content: {
124137
+ "application/json": {
124138
+ code: string;
124139
+ message: string;
124140
+ links?: {
124141
+ docs: string;
124142
+ schema: string;
124143
+ };
124144
+ issues?: {
124145
+ message: string;
124146
+ path?: (string | number)[];
124147
+ schema?: string;
124148
+ }[];
124149
+ retryable?: boolean;
124150
+ context?: unknown;
124151
+ };
124152
+ };
124153
+ };
124154
+ /** @description Forbidden */
124155
+ 403: {
124156
+ headers: {
124157
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124158
+ "Retry-After"?: number;
124159
+ [name: string]: unknown;
124160
+ };
124161
+ content: {
124162
+ "application/json": {
124163
+ code: string;
124164
+ message: string;
124165
+ links?: {
124166
+ docs: string;
124167
+ schema: string;
124168
+ };
124169
+ issues?: {
124170
+ message: string;
124171
+ path?: (string | number)[];
124172
+ schema?: string;
124173
+ }[];
124174
+ retryable?: boolean;
124175
+ context?: unknown;
124176
+ };
124177
+ };
124178
+ };
124179
+ /** @description Not found */
124180
+ 404: {
124181
+ headers: {
124182
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124183
+ "Retry-After"?: number;
124184
+ [name: string]: unknown;
124185
+ };
124186
+ content: {
124187
+ "application/json": {
124188
+ code: string;
124189
+ message: string;
124190
+ links?: {
124191
+ docs: string;
124192
+ schema: string;
124193
+ };
124194
+ issues?: {
124195
+ message: string;
124196
+ path?: (string | number)[];
124197
+ schema?: string;
124198
+ }[];
124199
+ retryable?: boolean;
124200
+ context?: unknown;
124201
+ };
124202
+ };
124203
+ };
124204
+ /** @description Conflict */
124205
+ 409: {
124206
+ headers: {
124207
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124208
+ "Retry-After"?: number;
124209
+ [name: string]: unknown;
124210
+ };
124211
+ content: {
124212
+ "application/json": {
124213
+ code: string;
124214
+ message: string;
124215
+ links?: {
124216
+ docs: string;
124217
+ schema: string;
124218
+ };
124219
+ issues?: {
124220
+ message: string;
124221
+ path?: (string | number)[];
124222
+ schema?: string;
124223
+ }[];
124224
+ retryable?: boolean;
124225
+ context?: unknown;
124226
+ };
124227
+ };
124228
+ };
124229
+ /** @description Gone */
124230
+ 410: {
124231
+ headers: {
124232
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124233
+ "Retry-After"?: number;
124234
+ [name: string]: unknown;
124235
+ };
124236
+ content: {
124237
+ "application/json": {
124238
+ code: string;
124239
+ message: string;
124240
+ links?: {
124241
+ docs: string;
124242
+ schema: string;
124243
+ };
124244
+ issues?: {
124245
+ message: string;
124246
+ path?: (string | number)[];
124247
+ schema?: string;
124248
+ }[];
124249
+ retryable?: boolean;
124250
+ context?: unknown;
124251
+ };
124252
+ };
124253
+ };
124254
+ /** @description Unprocessable content */
124255
+ 422: {
124256
+ headers: {
124257
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124258
+ "Retry-After"?: number;
124259
+ [name: string]: unknown;
124260
+ };
124261
+ content: {
124262
+ "application/json": {
124263
+ code: string;
124264
+ message: string;
124265
+ links?: {
124266
+ docs: string;
124267
+ schema: string;
124268
+ };
124269
+ issues?: {
124270
+ message: string;
124271
+ path?: (string | number)[];
124272
+ schema?: string;
124273
+ }[];
124274
+ retryable?: boolean;
124275
+ context?: unknown;
124276
+ };
124277
+ };
124278
+ };
124279
+ /** @description Internal server error */
124280
+ 500: {
124281
+ headers: {
124282
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124283
+ "Retry-After"?: number;
124284
+ [name: string]: unknown;
124285
+ };
124286
+ content: {
124287
+ "application/json": {
124288
+ code: string;
124289
+ message: string;
124290
+ links?: {
124291
+ docs: string;
124292
+ schema: string;
124293
+ };
124294
+ issues?: {
124295
+ message: string;
124296
+ path?: (string | number)[];
124297
+ schema?: string;
124298
+ }[];
124299
+ retryable?: boolean;
124300
+ context?: unknown;
124301
+ };
124302
+ };
124303
+ };
124304
+ /** @description Service unavailable */
124305
+ 503: {
124306
+ headers: {
124307
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
124308
+ "Retry-After"?: number;
124309
+ [name: string]: unknown;
124310
+ };
124311
+ content: {
124312
+ "application/json": {
124313
+ code: string;
124314
+ message: string;
124315
+ links?: {
124316
+ docs: string;
124317
+ schema: string;
124318
+ };
124319
+ issues?: {
124320
+ message: string;
124321
+ path?: (string | number)[];
124322
+ schema?: string;
124323
+ }[];
124324
+ retryable?: boolean;
124325
+ context?: unknown;
124326
+ };
124327
+ };
124328
+ };
124329
+ };
124330
+ };
124331
+ getTransactionsById: {
124332
+ parameters: {
124333
+ query?: never;
124334
+ header?: never;
124335
+ path: {
124336
+ id: string;
124337
+ };
124338
+ cookie?: never;
124339
+ };
124340
+ requestBody?: never;
124341
+ responses: {
124342
+ /** @description Successful response */
124343
+ 200: {
124344
+ headers: {
124345
+ [name: string]: unknown;
124346
+ };
124347
+ content: {
124348
+ "application/json": {
124349
+ description: string;
124350
+ /** @enum {string} */
124351
+ status: "active" | "inactive";
124352
+ uniqueRef?: string | null;
124353
+ isOpeningBalance: boolean;
124354
+ /** @enum {string} */
124355
+ type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
124356
+ date: string;
124357
+ lines: {
124358
+ uniqueRef?: string | null;
124359
+ description: string;
124360
+ /** @description System account purpose used to resolve or validate the posting account */
124361
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
124362
+ /** @description Value in cents (100 = 1€) */
124363
+ amount: number;
124364
+ /** @description Persisted owner statement linked to a payout line */
124365
+ ownerStatementId?: string | null;
124366
+ matchReservationConfirmationCode?: string | null;
124367
+ matchReservationStripeGuestRef?: string | null;
124368
+ matchReservationProcessorBookingRef?: string | null;
124369
+ matchLineTypeClassification?: string | null;
124370
+ id: string;
124371
+ issues: {
124372
+ /** @constant */
124373
+ code: "unassignedAccount";
124374
+ /** @constant */
124375
+ severity: "error";
124376
+ context: {
124377
+ lineType: string;
124378
+ };
124379
+ }[];
124380
+ recurringTemplate?: {
124381
+ id: string;
124382
+ } | null;
124383
+ total: number;
124384
+ listing?: {
124385
+ /** Format: uuid */
124386
+ id: string;
124387
+ name: string;
124388
+ uniqueRef?: string | null;
124389
+ shortRef?: string | null;
124390
+ } | null;
124391
+ reservation?: {
124392
+ id: string;
124393
+ shortRef?: string | null;
124394
+ confirmationCode?: string | null;
124395
+ uniqueRef: string;
124396
+ /** @enum {string} */
124397
+ status: "booked" | "canceled" | "inactive";
124398
+ checkIn?: string | null;
124399
+ checkOut?: string | null;
124400
+ } | null;
124401
+ account?: {
124402
+ id: string;
124403
+ name: string;
124404
+ uniqueRef?: string | null;
124405
+ /** @enum {string} */
124406
+ status: "active" | "inactive";
124407
+ } | null;
124408
+ /**
124409
+ * @description Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting
124410
+ * @enum {string}
124411
+ */
124412
+ party: "owners" | "manager";
124413
+ contact?: {
124414
+ /** Format: uuid */
124415
+ id: string;
124416
+ name?: string | null;
124417
+ firstName?: string | null;
124418
+ uniqueRef?: string | null;
124419
+ shortRef?: string | null;
124420
+ email?: string | null;
124421
+ /** @enum {string} */
124422
+ type: "owner" | "vendor";
124423
+ } | null;
124424
+ matchStatus?: string | null;
124425
+ appliedAmount?: {
124426
+ taxBehavior?: ("excluded" | "included") | null;
124427
+ taxRate?: {
124428
+ id: string;
124429
+ name: string;
124430
+ /**
124431
+ * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
124432
+ * @example 100000
124433
+ */
124434
+ basisPoints: number;
124435
+ } | null;
124436
+ } | null;
124437
+ markup?: {
124438
+ amount?: number | null;
124439
+ taxBehavior?: ("excluded" | "included") | null;
124440
+ taxRate?: {
124441
+ id: string;
124442
+ name: string;
124443
+ /**
124444
+ * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
124445
+ * @example 100000
124446
+ */
124447
+ basisPoints: number;
124448
+ } | null;
124449
+ } | null;
124450
+ lock?: {
124451
+ /**
124452
+ * @description Whether the represented entity or field can be mutated
124453
+ * @enum {string}
124454
+ */
124455
+ status: "locked" | "unlocked";
124456
+ /** @description Present when books closing blocks the mutation */
124457
+ booksClosed?: {
124458
+ /** @description First open accounting date */
124459
+ date: string;
124460
+ } | null;
124461
+ /** @description Present when journal entries are attached to owner statements */
124462
+ ownerStatement?: {
124463
+ /** @description Owner statements that lock the represented data */
124464
+ ids: string[];
124465
+ } | null;
124466
+ reconciled?: {
124467
+ /** @description Bank records linked through reconciliation */
124468
+ bankRecordIds: string[];
124469
+ } | null;
124470
+ /** @description Listing statement-period conflicts for the represented data */
124471
+ statementPeriod?: {
124472
+ hits: {
124473
+ /** Format: uuid */
124474
+ listingId: string;
124475
+ /** @description Posting date blocked by the statement period */
124476
+ txnAt: string;
124477
+ /** @description First open date for this listing period */
124478
+ openFrom: string;
124479
+ }[];
124480
+ } | null;
124481
+ } | null;
124482
+ }[];
124483
+ /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
124484
+ attachmentIds?: string[] | null;
124485
+ recurringTemplateId?: string | null;
124486
+ matchBankAccountLast4?: string | null;
124487
+ id: string;
124488
+ shortRef?: string | null;
124489
+ lock?: {
124490
+ /**
124491
+ * @description Whether the represented entity or field can be mutated
124492
+ * @enum {string}
124493
+ */
124494
+ status: "locked" | "unlocked";
124495
+ /** @description Present when books closing blocks the mutation */
124496
+ booksClosed?: {
124497
+ /** @description First open accounting date */
124498
+ date: string;
124499
+ } | null;
124500
+ /** @description Present when journal entries are attached to owner statements */
124501
+ ownerStatement?: {
124502
+ /** @description Owner statements that lock the represented data */
124503
+ ids: string[];
124504
+ } | null;
124505
+ reconciled?: {
124506
+ /** @description Bank records linked through reconciliation */
124507
+ bankRecordIds: string[];
124508
+ } | null;
124509
+ /** @description Listing statement-period conflicts for the represented data */
124510
+ statementPeriod?: {
124511
+ hits: {
124512
+ /** Format: uuid */
124513
+ listingId: string;
124514
+ /** @description Posting date blocked by the statement period */
124515
+ txnAt: string;
124516
+ /** @description First open date for this listing period */
124517
+ openFrom: string;
124518
+ }[];
124519
+ } | null;
124520
+ } | null;
124521
+ issues: ({
124522
+ /** @constant */
124523
+ code: "line_unassignedAccount";
124524
+ /** @constant */
124525
+ severity: "error";
124526
+ context: Record<string, never>;
124527
+ } | {
124528
+ /** @constant */
124529
+ code: "bankAccountLast4Mismatch";
124530
+ /** @constant */
124531
+ severity: "warning";
124532
+ context: {
124533
+ accountLast4: string;
124534
+ transactionLast4: string;
124535
+ };
124536
+ })[];
124537
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
124538
+ currency: string;
124539
+ /** @description Value in cents (100 = 1€) */
124540
+ amount: number;
124541
+ recurringTemplate?: {
124542
+ id: string;
124543
+ } | null;
124544
+ attachments: {
124545
+ /** Format: uuid */
124546
+ id: string;
124547
+ transactionId: string | null;
124548
+ /**
124549
+ * Format: date-time
124550
+ * @description Timestamp string with date, time, milliseconds, and timezone.
124551
+ * @example 2024-01-15T12:30:00.000+00:00
124552
+ */
124553
+ createdAt: string;
124554
+ filename: string;
124555
+ extension?: string | null;
124556
+ contentType: string;
124557
+ byteSize: number;
124558
+ isOwnerAccessible: boolean;
124559
+ }[];
124560
+ account?: {
124561
+ id: string;
124562
+ name: string;
124563
+ uniqueRef?: string | null;
124564
+ /** @enum {string} */
124565
+ status: "active" | "inactive";
124566
+ } | null;
124567
+ payment: {
124568
+ /** @description Bank records reconciled to this transaction payment */
124569
+ bankRecordIds: string[];
124570
+ /**
124571
+ * @description Expense payment status
124572
+ * @enum {string}
124573
+ */
124574
+ status: "unpaid" | "underpaid" | "overpaid" | "paid";
124575
+ lock?: {
124576
+ /**
124577
+ * @description Whether the represented entity or field can be mutated
124578
+ * @enum {string}
124579
+ */
124580
+ status: "locked" | "unlocked";
124581
+ /** @description Present when books closing blocks the mutation */
124582
+ booksClosed?: {
124583
+ /** @description First open accounting date */
124584
+ date: string;
124585
+ } | null;
124586
+ /** @description Present when journal entries are attached to owner statements */
124587
+ ownerStatement?: {
124588
+ /** @description Owner statements that lock the represented data */
124589
+ ids: string[];
124590
+ } | null;
124591
+ reconciled?: {
124592
+ /** @description Bank records linked through reconciliation */
124593
+ bankRecordIds: string[];
124594
+ } | null;
124595
+ /** @description Listing statement-period conflicts for the represented data */
124596
+ statementPeriod?: {
124597
+ hits: {
124598
+ /** Format: uuid */
124599
+ listingId: string;
124600
+ /** @description Posting date blocked by the statement period */
124601
+ txnAt: string;
124602
+ /** @description First open date for this listing period */
124603
+ openFrom: string;
124604
+ }[];
124605
+ } | null;
124606
+ } | null;
124607
+ date?: string | null;
124608
+ };
124609
+ connection?: {
124610
+ /** Format: uuid */
124611
+ id: string;
124612
+ name: string;
124613
+ /** @enum {string} */
124614
+ status: "active" | "inactive";
124615
+ uniqueRef?: string | null;
124616
+ appId: string;
124617
+ } | null;
124618
+ contact?: {
124619
+ /** Format: uuid */
124620
+ id: string;
124621
+ name?: string | null;
124622
+ firstName?: string | null;
124623
+ uniqueRef?: string | null;
124624
+ shortRef?: string | null;
124625
+ email?: string | null;
124626
+ /** @enum {string} */
124627
+ type: "owner" | "vendor";
124628
+ } | null;
124629
+ source?: {
124630
+ /** Format: uuid */
124631
+ id: string;
124632
+ type: string;
124633
+ status?: ("active" | "inactive") | null;
124634
+ appId?: string | null;
124635
+ appIcon?: string | null;
124636
+ } | null;
124637
+ matchStatus?: string | null;
124638
+ matchedByBankRule: boolean;
124639
+ providerPayment: {
124640
+ /** Format: uuid */
124641
+ id: string;
124642
+ /** @constant */
124643
+ provider: "ramp";
124644
+ /** Format: uuid */
124645
+ connectionId: string;
124646
+ /** Format: uuid */
124647
+ transactionId: string;
124648
+ syncId: string | null;
124649
+ /** @enum {string} */
124650
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
124651
+ externalRef: string | null;
124652
+ failureReason: string | null;
124653
+ attemptId: string;
124654
+ attempt: number;
124655
+ /**
124656
+ * Format: date-time
124657
+ * @description Timestamp string with date, time, milliseconds, and timezone.
124658
+ * @example 2024-01-15T12:30:00.000+00:00
124659
+ */
124660
+ createdAt: string;
124661
+ /**
124662
+ * Format: date-time
124663
+ * @description Timestamp string with date, time, milliseconds, and timezone.
124664
+ * @example 2024-01-15T12:30:00.000+00:00
124665
+ */
124666
+ updatedAt: string;
124667
+ } | null;
122926
124668
  };
122927
124669
  };
122928
124670
  };
@@ -123153,16 +124895,196 @@ export interface operations {
123153
124895
  };
123154
124896
  };
123155
124897
  };
123156
- getTransactionsById: {
124898
+ putTransactionsById: {
123157
124899
  parameters: {
123158
- query?: never;
124900
+ query?: {
124901
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
124902
+ dryRun?: boolean;
124903
+ };
123159
124904
  header?: never;
123160
124905
  path: {
123161
124906
  id: string;
123162
124907
  };
123163
124908
  cookie?: never;
123164
124909
  };
123165
- requestBody?: never;
124910
+ requestBody?: {
124911
+ content: {
124912
+ "application/json": {
124913
+ description?: string;
124914
+ status?: ("active" | "inactive") | null;
124915
+ /** @description Root bank account; the source account for transfers */
124916
+ accountId?: string | null;
124917
+ /** @description Transaction contact; required for non-opening-balance expenses */
124918
+ contactId?: string | null;
124919
+ uniqueRef?: string | null;
124920
+ isOpeningBalance?: boolean;
124921
+ /**
124922
+ * @description Public transaction type. Transfers are internal bank-to-bank movements; payouts represent owner or manager distributions.
124923
+ * @enum {string}
124924
+ */
124925
+ type?: "deposit" | "expense" | "transfer" | "payout";
124926
+ date?: string;
124927
+ currency?: string | null;
124928
+ /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
124929
+ attachmentIds?: string[] | null;
124930
+ /** @description Expense payment and reconciliation state */
124931
+ payment?: {
124932
+ /** @description Bank records reconciled to this transaction payment */
124933
+ bankRecordIds?: string[];
124934
+ /**
124935
+ * @description Expense payment status
124936
+ * @enum {string}
124937
+ */
124938
+ status?: "unpaid" | "underpaid" | "overpaid" | "paid";
124939
+ /** @description Payment posting date; paid expenses default to the transaction date */
124940
+ date?: string | null;
124941
+ lock?: {
124942
+ /**
124943
+ * @description Whether the represented entity or field can be mutated
124944
+ * @enum {string}
124945
+ */
124946
+ status: "locked" | "unlocked";
124947
+ /** @description Present when books closing blocks the mutation */
124948
+ booksClosed?: {
124949
+ /** @description First open accounting date */
124950
+ date: string;
124951
+ } | null;
124952
+ /** @description Present when journal entries are attached to owner statements */
124953
+ ownerStatement?: {
124954
+ /** @description Owner statements that lock the represented data */
124955
+ ids: string[];
124956
+ } | null;
124957
+ reconciled?: {
124958
+ /** @description Bank records linked through reconciliation */
124959
+ bankRecordIds: string[];
124960
+ } | null;
124961
+ /** @description Listing statement-period conflicts for the represented data */
124962
+ statementPeriod?: {
124963
+ hits: {
124964
+ /** Format: uuid */
124965
+ listingId: string;
124966
+ /** @description Posting date blocked by the statement period */
124967
+ txnAt: string;
124968
+ /** @description First open date for this listing period */
124969
+ openFrom: string;
124970
+ }[];
124971
+ } | null;
124972
+ } | null;
124973
+ } | null;
124974
+ connectionId?: string | null;
124975
+ sourceId?: string | null;
124976
+ recurringTemplateId?: string | null;
124977
+ matchBankAccountLast4?: string | null;
124978
+ lines?: {
124979
+ recurringTemplateId?: string | null;
124980
+ uniqueRef?: string | null;
124981
+ description?: string;
124982
+ /** @description Explicit posting account for this transaction line */
124983
+ accountId?: string | null;
124984
+ /** @description System account purpose used to resolve or validate the posting account */
124985
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
124986
+ /** @description Value in cents (100 = 1€) */
124987
+ amount?: number;
124988
+ appliedAmount?: {
124989
+ taxRateId?: string | null;
124990
+ taxBehavior?: ("excluded" | "included") | null;
124991
+ } | null;
124992
+ markup?: {
124993
+ amount?: number | null;
124994
+ taxRateId?: string | null;
124995
+ taxBehavior?: ("excluded" | "included") | null;
124996
+ } | null;
124997
+ /** @description Listing attribution and owner-statement context for this line */
124998
+ listingId?: string | null;
124999
+ /** @description Reservation attribution; its listing becomes authoritative when resolved */
125000
+ reservationId?: string | null;
125001
+ /** @description Persisted owner statement linked to a payout line */
125002
+ ownerStatementId?: string | null;
125003
+ /** @description Optional accounting party. Defaults and allowed values depend on transaction type, listing or reservation context, account assignment, and account category. */
125004
+ party?: ("owners" | "manager") | null;
125005
+ contactId?: string | null;
125006
+ matchReservationConfirmationCode?: string | null;
125007
+ matchReservationStripeGuestRef?: string | null;
125008
+ matchReservationProcessorBookingRef?: string | null;
125009
+ matchLineTypeClassification?: string | null;
125010
+ id?: string;
125011
+ }[] | null;
125012
+ /** @description Lines to be added (can not be combined with "lines" in the same request) */
125013
+ lines_create?: {
125014
+ recurringTemplateId?: string | null;
125015
+ uniqueRef?: string | null;
125016
+ description: string;
125017
+ /** @description Explicit posting account for this transaction line */
125018
+ accountId?: string | null;
125019
+ /** @description System account purpose used to resolve or validate the posting account */
125020
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
125021
+ /** @description Value in cents (100 = 1€) */
125022
+ amount: number;
125023
+ appliedAmount?: {
125024
+ taxRateId?: string | null;
125025
+ taxBehavior?: ("excluded" | "included") | null;
125026
+ } | null;
125027
+ markup?: {
125028
+ amount?: number | null;
125029
+ taxRateId?: string | null;
125030
+ taxBehavior?: ("excluded" | "included") | null;
125031
+ } | null;
125032
+ /** @description Listing attribution and owner-statement context for this line */
125033
+ listingId?: string | null;
125034
+ /** @description Reservation attribution; its listing becomes authoritative when resolved */
125035
+ reservationId?: string | null;
125036
+ /** @description Persisted owner statement linked to a payout line */
125037
+ ownerStatementId?: string | null;
125038
+ /** @description Optional accounting party. Defaults and allowed values depend on transaction type, listing or reservation context, account assignment, and account category. */
125039
+ party?: ("owners" | "manager") | null;
125040
+ contactId?: string | null;
125041
+ matchReservationConfirmationCode?: string | null;
125042
+ matchReservationStripeGuestRef?: string | null;
125043
+ matchReservationProcessorBookingRef?: string | null;
125044
+ matchLineTypeClassification?: string | null;
125045
+ id?: string | null;
125046
+ }[] | null;
125047
+ /** @description Lines to be updated (can not be combined with "lines" in the same request) */
125048
+ lines_update?: {
125049
+ recurringTemplateId?: string | null;
125050
+ uniqueRef?: string | null;
125051
+ description?: string;
125052
+ /** @description Explicit posting account for this transaction line */
125053
+ accountId?: string | null;
125054
+ /** @description System account purpose used to resolve or validate the posting account */
125055
+ assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
125056
+ /** @description Value in cents (100 = 1€) */
125057
+ amount?: number;
125058
+ appliedAmount?: {
125059
+ taxRateId?: string | null;
125060
+ taxBehavior?: ("excluded" | "included") | null;
125061
+ } | null;
125062
+ markup?: {
125063
+ amount?: number | null;
125064
+ taxRateId?: string | null;
125065
+ taxBehavior?: ("excluded" | "included") | null;
125066
+ } | null;
125067
+ /** @description Listing attribution and owner-statement context for this line */
125068
+ listingId?: string | null;
125069
+ /** @description Reservation attribution; its listing becomes authoritative when resolved */
125070
+ reservationId?: string | null;
125071
+ /** @description Persisted owner statement linked to a payout line */
125072
+ ownerStatementId?: string | null;
125073
+ /** @description Optional accounting party. Defaults and allowed values depend on transaction type, listing or reservation context, account assignment, and account category. */
125074
+ party?: ("owners" | "manager") | null;
125075
+ contactId?: string | null;
125076
+ matchReservationConfirmationCode?: string | null;
125077
+ matchReservationStripeGuestRef?: string | null;
125078
+ matchReservationProcessorBookingRef?: string | null;
125079
+ matchLineTypeClassification?: string | null;
125080
+ /** Format: uuid */
125081
+ id: string;
125082
+ }[] | null;
125083
+ /** @description Lines to be deleted (can not be combined with "lines" in the same request) */
125084
+ lines_delete?: string[] | null;
125085
+ };
125086
+ };
125087
+ };
123166
125088
  responses: {
123167
125089
  /** @description Successful response */
123168
125090
  200: {
@@ -123691,7 +125613,261 @@ export interface operations {
123691
125613
  };
123692
125614
  };
123693
125615
  };
123694
- putTransactionsById: {
125616
+ deleteTransactionsById: {
125617
+ parameters: {
125618
+ query?: {
125619
+ onLocked?: "error" | "archive";
125620
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
125621
+ dryRun?: boolean;
125622
+ };
125623
+ header?: never;
125624
+ path: {
125625
+ id: string;
125626
+ };
125627
+ cookie?: never;
125628
+ };
125629
+ requestBody?: never;
125630
+ responses: {
125631
+ /** @description Successful response */
125632
+ 200: {
125633
+ headers: {
125634
+ [name: string]: unknown;
125635
+ };
125636
+ content: {
125637
+ "application/json": {
125638
+ /** @enum {string} */
125639
+ status: "deleted" | "archived";
125640
+ };
125641
+ };
125642
+ };
125643
+ /** @description Bad request */
125644
+ 400: {
125645
+ headers: {
125646
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125647
+ "Retry-After"?: number;
125648
+ [name: string]: unknown;
125649
+ };
125650
+ content: {
125651
+ "application/json": {
125652
+ code: string;
125653
+ message: string;
125654
+ links?: {
125655
+ docs: string;
125656
+ schema: string;
125657
+ };
125658
+ issues?: {
125659
+ message: string;
125660
+ path?: (string | number)[];
125661
+ schema?: string;
125662
+ }[];
125663
+ retryable?: boolean;
125664
+ context?: unknown;
125665
+ };
125666
+ };
125667
+ };
125668
+ /** @description Unauthorized */
125669
+ 401: {
125670
+ headers: {
125671
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125672
+ "Retry-After"?: number;
125673
+ [name: string]: unknown;
125674
+ };
125675
+ content: {
125676
+ "application/json": {
125677
+ code: string;
125678
+ message: string;
125679
+ links?: {
125680
+ docs: string;
125681
+ schema: string;
125682
+ };
125683
+ issues?: {
125684
+ message: string;
125685
+ path?: (string | number)[];
125686
+ schema?: string;
125687
+ }[];
125688
+ retryable?: boolean;
125689
+ context?: unknown;
125690
+ };
125691
+ };
125692
+ };
125693
+ /** @description Forbidden */
125694
+ 403: {
125695
+ headers: {
125696
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125697
+ "Retry-After"?: number;
125698
+ [name: string]: unknown;
125699
+ };
125700
+ content: {
125701
+ "application/json": {
125702
+ code: string;
125703
+ message: string;
125704
+ links?: {
125705
+ docs: string;
125706
+ schema: string;
125707
+ };
125708
+ issues?: {
125709
+ message: string;
125710
+ path?: (string | number)[];
125711
+ schema?: string;
125712
+ }[];
125713
+ retryable?: boolean;
125714
+ context?: unknown;
125715
+ };
125716
+ };
125717
+ };
125718
+ /** @description Not found */
125719
+ 404: {
125720
+ headers: {
125721
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125722
+ "Retry-After"?: number;
125723
+ [name: string]: unknown;
125724
+ };
125725
+ content: {
125726
+ "application/json": {
125727
+ code: string;
125728
+ message: string;
125729
+ links?: {
125730
+ docs: string;
125731
+ schema: string;
125732
+ };
125733
+ issues?: {
125734
+ message: string;
125735
+ path?: (string | number)[];
125736
+ schema?: string;
125737
+ }[];
125738
+ retryable?: boolean;
125739
+ context?: unknown;
125740
+ };
125741
+ };
125742
+ };
125743
+ /** @description Conflict */
125744
+ 409: {
125745
+ headers: {
125746
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125747
+ "Retry-After"?: number;
125748
+ [name: string]: unknown;
125749
+ };
125750
+ content: {
125751
+ "application/json": {
125752
+ code: string;
125753
+ message: string;
125754
+ links?: {
125755
+ docs: string;
125756
+ schema: string;
125757
+ };
125758
+ issues?: {
125759
+ message: string;
125760
+ path?: (string | number)[];
125761
+ schema?: string;
125762
+ }[];
125763
+ retryable?: boolean;
125764
+ context?: unknown;
125765
+ };
125766
+ };
125767
+ };
125768
+ /** @description Gone */
125769
+ 410: {
125770
+ headers: {
125771
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125772
+ "Retry-After"?: number;
125773
+ [name: string]: unknown;
125774
+ };
125775
+ content: {
125776
+ "application/json": {
125777
+ code: string;
125778
+ message: string;
125779
+ links?: {
125780
+ docs: string;
125781
+ schema: string;
125782
+ };
125783
+ issues?: {
125784
+ message: string;
125785
+ path?: (string | number)[];
125786
+ schema?: string;
125787
+ }[];
125788
+ retryable?: boolean;
125789
+ context?: unknown;
125790
+ };
125791
+ };
125792
+ };
125793
+ /** @description Unprocessable content */
125794
+ 422: {
125795
+ headers: {
125796
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125797
+ "Retry-After"?: number;
125798
+ [name: string]: unknown;
125799
+ };
125800
+ content: {
125801
+ "application/json": {
125802
+ code: string;
125803
+ message: string;
125804
+ links?: {
125805
+ docs: string;
125806
+ schema: string;
125807
+ };
125808
+ issues?: {
125809
+ message: string;
125810
+ path?: (string | number)[];
125811
+ schema?: string;
125812
+ }[];
125813
+ retryable?: boolean;
125814
+ context?: unknown;
125815
+ };
125816
+ };
125817
+ };
125818
+ /** @description Internal server error */
125819
+ 500: {
125820
+ headers: {
125821
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125822
+ "Retry-After"?: number;
125823
+ [name: string]: unknown;
125824
+ };
125825
+ content: {
125826
+ "application/json": {
125827
+ code: string;
125828
+ message: string;
125829
+ links?: {
125830
+ docs: string;
125831
+ schema: string;
125832
+ };
125833
+ issues?: {
125834
+ message: string;
125835
+ path?: (string | number)[];
125836
+ schema?: string;
125837
+ }[];
125838
+ retryable?: boolean;
125839
+ context?: unknown;
125840
+ };
125841
+ };
125842
+ };
125843
+ /** @description Service unavailable */
125844
+ 503: {
125845
+ headers: {
125846
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
125847
+ "Retry-After"?: number;
125848
+ [name: string]: unknown;
125849
+ };
125850
+ content: {
125851
+ "application/json": {
125852
+ code: string;
125853
+ message: string;
125854
+ links?: {
125855
+ docs: string;
125856
+ schema: string;
125857
+ };
125858
+ issues?: {
125859
+ message: string;
125860
+ path?: (string | number)[];
125861
+ schema?: string;
125862
+ }[];
125863
+ retryable?: boolean;
125864
+ context?: unknown;
125865
+ };
125866
+ };
125867
+ };
125868
+ };
125869
+ };
125870
+ postTransactionsByIdPay: {
123695
125871
  parameters: {
123696
125872
  query?: {
123697
125873
  /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
@@ -123706,178 +125882,10 @@ export interface operations {
123706
125882
  requestBody?: {
123707
125883
  content: {
123708
125884
  "application/json": {
123709
- description?: string;
123710
- status?: ("active" | "inactive") | null;
123711
- /** @description Root bank account; the source account for transfers */
123712
- accountId?: string | null;
123713
- /** @description Transaction contact; required for non-opening-balance expenses */
123714
- contactId?: string | null;
123715
- uniqueRef?: string | null;
123716
- isOpeningBalance?: boolean;
123717
- /**
123718
- * @description Public transaction type. Transfers are internal bank-to-bank movements; payouts represent owner or manager distributions.
123719
- * @enum {string}
123720
- */
123721
- type?: "deposit" | "expense" | "transfer" | "payout";
123722
- date?: string;
123723
- currency?: string | null;
123724
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
123725
- attachmentIds?: string[] | null;
123726
- /** @description Expense payment and reconciliation state */
123727
- payment?: {
123728
- /** @description Bank records reconciled to this transaction payment */
123729
- bankRecordIds?: string[];
123730
- /**
123731
- * @description Expense payment status
123732
- * @enum {string}
123733
- */
123734
- status?: "unpaid" | "underpaid" | "overpaid" | "paid";
123735
- /** @description Payment posting date; paid expenses default to the transaction date */
123736
- date?: string | null;
123737
- lock?: {
123738
- /**
123739
- * @description Whether the represented entity or field can be mutated
123740
- * @enum {string}
123741
- */
123742
- status: "locked" | "unlocked";
123743
- /** @description Present when books closing blocks the mutation */
123744
- booksClosed?: {
123745
- /** @description First open accounting date */
123746
- date: string;
123747
- } | null;
123748
- /** @description Present when journal entries are attached to owner statements */
123749
- ownerStatement?: {
123750
- /** @description Owner statements that lock the represented data */
123751
- ids: string[];
123752
- } | null;
123753
- reconciled?: {
123754
- /** @description Bank records linked through reconciliation */
123755
- bankRecordIds: string[];
123756
- } | null;
123757
- /** @description Listing statement-period conflicts for the represented data */
123758
- statementPeriod?: {
123759
- hits: {
123760
- /** Format: uuid */
123761
- listingId: string;
123762
- /** @description Posting date blocked by the statement period */
123763
- txnAt: string;
123764
- /** @description First open date for this listing period */
123765
- openFrom: string;
123766
- }[];
123767
- } | null;
123768
- } | null;
123769
- } | null;
123770
- connectionId?: string | null;
123771
- sourceId?: string | null;
123772
- recurringTemplateId?: string | null;
123773
- matchBankAccountLast4?: string | null;
123774
- lines?: {
123775
- recurringTemplateId?: string | null;
123776
- uniqueRef?: string | null;
123777
- description?: string;
123778
- /** @description Explicit posting account for this transaction line */
123779
- accountId?: string | null;
123780
- /** @description System account purpose used to resolve or validate the posting account */
123781
- assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
123782
- /** @description Value in cents (100 = 1€) */
123783
- amount?: number;
123784
- appliedAmount?: {
123785
- taxRateId?: string | null;
123786
- taxBehavior?: ("excluded" | "included") | null;
123787
- } | null;
123788
- markup?: {
123789
- amount?: number | null;
123790
- taxRateId?: string | null;
123791
- taxBehavior?: ("excluded" | "included") | null;
123792
- } | null;
123793
- /** @description Listing attribution and owner-statement context for this line */
123794
- listingId?: string | null;
123795
- /** @description Reservation attribution; its listing becomes authoritative when resolved */
123796
- reservationId?: string | null;
123797
- /** @description Persisted owner statement linked to a payout line */
123798
- ownerStatementId?: string | null;
123799
- /** @description Optional accounting party. Defaults and allowed values depend on transaction type, listing or reservation context, account assignment, and account category. */
123800
- party?: ("owners" | "manager") | null;
123801
- contactId?: string | null;
123802
- matchReservationConfirmationCode?: string | null;
123803
- matchReservationStripeGuestRef?: string | null;
123804
- matchReservationProcessorBookingRef?: string | null;
123805
- matchLineTypeClassification?: string | null;
123806
- id?: string;
123807
- }[] | null;
123808
- /** @description Lines to be added (can not be combined with "lines" in the same request) */
123809
- lines_create?: {
123810
- recurringTemplateId?: string | null;
123811
- uniqueRef?: string | null;
123812
- description: string;
123813
- /** @description Explicit posting account for this transaction line */
123814
- accountId?: string | null;
123815
- /** @description System account purpose used to resolve or validate the posting account */
123816
- assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
123817
- /** @description Value in cents (100 = 1€) */
123818
- amount: number;
123819
- appliedAmount?: {
123820
- taxRateId?: string | null;
123821
- taxBehavior?: ("excluded" | "included") | null;
123822
- } | null;
123823
- markup?: {
123824
- amount?: number | null;
123825
- taxRateId?: string | null;
123826
- taxBehavior?: ("excluded" | "included") | null;
123827
- } | null;
123828
- /** @description Listing attribution and owner-statement context for this line */
123829
- listingId?: string | null;
123830
- /** @description Reservation attribution; its listing becomes authoritative when resolved */
123831
- reservationId?: string | null;
123832
- /** @description Persisted owner statement linked to a payout line */
123833
- ownerStatementId?: string | null;
123834
- /** @description Optional accounting party. Defaults and allowed values depend on transaction type, listing or reservation context, account assignment, and account category. */
123835
- party?: ("owners" | "manager") | null;
123836
- contactId?: string | null;
123837
- matchReservationConfirmationCode?: string | null;
123838
- matchReservationStripeGuestRef?: string | null;
123839
- matchReservationProcessorBookingRef?: string | null;
123840
- matchLineTypeClassification?: string | null;
123841
- id?: string | null;
123842
- }[] | null;
123843
- /** @description Lines to be updated (can not be combined with "lines" in the same request) */
123844
- lines_update?: {
123845
- recurringTemplateId?: string | null;
123846
- uniqueRef?: string | null;
123847
- description?: string;
123848
- /** @description Explicit posting account for this transaction line */
123849
- accountId?: string | null;
123850
- /** @description System account purpose used to resolve or validate the posting account */
123851
- assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
123852
- /** @description Value in cents (100 = 1€) */
123853
- amount?: number;
123854
- appliedAmount?: {
123855
- taxRateId?: string | null;
123856
- taxBehavior?: ("excluded" | "included") | null;
123857
- } | null;
123858
- markup?: {
123859
- amount?: number | null;
123860
- taxRateId?: string | null;
123861
- taxBehavior?: ("excluded" | "included") | null;
123862
- } | null;
123863
- /** @description Listing attribution and owner-statement context for this line */
123864
- listingId?: string | null;
123865
- /** @description Reservation attribution; its listing becomes authoritative when resolved */
123866
- reservationId?: string | null;
123867
- /** @description Persisted owner statement linked to a payout line */
123868
- ownerStatementId?: string | null;
123869
- /** @description Optional accounting party. Defaults and allowed values depend on transaction type, listing or reservation context, account assignment, and account category. */
123870
- party?: ("owners" | "manager") | null;
123871
- contactId?: string | null;
123872
- matchReservationConfirmationCode?: string | null;
123873
- matchReservationStripeGuestRef?: string | null;
123874
- matchReservationProcessorBookingRef?: string | null;
123875
- matchLineTypeClassification?: string | null;
123876
- /** Format: uuid */
123877
- id: string;
123878
- }[] | null;
123879
- /** @description Lines to be deleted (can not be combined with "lines" in the same request) */
123880
- lines_delete?: string[] | null;
125885
+ provider: "ramp" | null;
125886
+ date?: string | null;
125887
+ fundingAccountId?: string | null;
125888
+ idempotencyKey?: string;
123881
125889
  };
123882
125890
  };
123883
125891
  };
@@ -123889,296 +125897,39 @@ export interface operations {
123889
125897
  };
123890
125898
  content: {
123891
125899
  "application/json": {
123892
- description: string;
123893
- /** @enum {string} */
123894
- status: "active" | "inactive";
123895
- uniqueRef?: string | null;
123896
- isOpeningBalance: boolean;
123897
- /** @enum {string} */
123898
- type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
123899
- date: string;
123900
- lines: {
123901
- uniqueRef?: string | null;
123902
- description: string;
123903
- /** @description System account purpose used to resolve or validate the posting account */
123904
- assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
123905
- /** @description Value in cents (100 = 1€) */
123906
- amount: number;
123907
- /** @description Persisted owner statement linked to a payout line */
123908
- ownerStatementId?: string | null;
123909
- matchReservationConfirmationCode?: string | null;
123910
- matchReservationStripeGuestRef?: string | null;
123911
- matchReservationProcessorBookingRef?: string | null;
123912
- matchLineTypeClassification?: string | null;
123913
- id: string;
123914
- issues: {
123915
- /** @constant */
123916
- code: "unassignedAccount";
123917
- /** @constant */
123918
- severity: "error";
123919
- context: {
123920
- lineType: string;
123921
- };
123922
- }[];
123923
- recurringTemplate?: {
123924
- id: string;
123925
- } | null;
123926
- total: number;
123927
- listing?: {
123928
- /** Format: uuid */
123929
- id: string;
123930
- name: string;
123931
- uniqueRef?: string | null;
123932
- shortRef?: string | null;
123933
- } | null;
123934
- reservation?: {
123935
- id: string;
123936
- shortRef?: string | null;
123937
- confirmationCode?: string | null;
123938
- uniqueRef: string;
123939
- /** @enum {string} */
123940
- status: "booked" | "canceled" | "inactive";
123941
- checkIn?: string | null;
123942
- checkOut?: string | null;
123943
- } | null;
123944
- account?: {
123945
- id: string;
123946
- name: string;
123947
- uniqueRef?: string | null;
123948
- /** @enum {string} */
123949
- status: "active" | "inactive";
123950
- } | null;
123951
- /**
123952
- * @description Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting
123953
- * @enum {string}
123954
- */
123955
- party: "owners" | "manager";
123956
- contact?: {
123957
- /** Format: uuid */
123958
- id: string;
123959
- name?: string | null;
123960
- firstName?: string | null;
123961
- uniqueRef?: string | null;
123962
- shortRef?: string | null;
123963
- email?: string | null;
123964
- /** @enum {string} */
123965
- type: "owner" | "vendor";
123966
- } | null;
123967
- matchStatus?: string | null;
123968
- appliedAmount?: {
123969
- taxBehavior?: ("excluded" | "included") | null;
123970
- taxRate?: {
123971
- id: string;
123972
- name: string;
123973
- /**
123974
- * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
123975
- * @example 100000
123976
- */
123977
- basisPoints: number;
123978
- } | null;
123979
- } | null;
123980
- markup?: {
123981
- amount?: number | null;
123982
- taxBehavior?: ("excluded" | "included") | null;
123983
- taxRate?: {
123984
- id: string;
123985
- name: string;
123986
- /**
123987
- * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
123988
- * @example 100000
123989
- */
123990
- basisPoints: number;
123991
- } | null;
123992
- } | null;
123993
- lock?: {
123994
- /**
123995
- * @description Whether the represented entity or field can be mutated
123996
- * @enum {string}
123997
- */
123998
- status: "locked" | "unlocked";
123999
- /** @description Present when books closing blocks the mutation */
124000
- booksClosed?: {
124001
- /** @description First open accounting date */
124002
- date: string;
124003
- } | null;
124004
- /** @description Present when journal entries are attached to owner statements */
124005
- ownerStatement?: {
124006
- /** @description Owner statements that lock the represented data */
124007
- ids: string[];
124008
- } | null;
124009
- reconciled?: {
124010
- /** @description Bank records linked through reconciliation */
124011
- bankRecordIds: string[];
124012
- } | null;
124013
- /** @description Listing statement-period conflicts for the represented data */
124014
- statementPeriod?: {
124015
- hits: {
124016
- /** Format: uuid */
124017
- listingId: string;
124018
- /** @description Posting date blocked by the statement period */
124019
- txnAt: string;
124020
- /** @description First open date for this listing period */
124021
- openFrom: string;
124022
- }[];
124023
- } | null;
124024
- } | null;
124025
- }[];
124026
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
124027
- attachmentIds?: string[] | null;
124028
- recurringTemplateId?: string | null;
124029
- matchBankAccountLast4?: string | null;
125900
+ /** Format: uuid */
124030
125901
  id: string;
124031
- shortRef?: string | null;
124032
- lock?: {
124033
- /**
124034
- * @description Whether the represented entity or field can be mutated
124035
- * @enum {string}
124036
- */
124037
- status: "locked" | "unlocked";
124038
- /** @description Present when books closing blocks the mutation */
124039
- booksClosed?: {
124040
- /** @description First open accounting date */
124041
- date: string;
124042
- } | null;
124043
- /** @description Present when journal entries are attached to owner statements */
124044
- ownerStatement?: {
124045
- /** @description Owner statements that lock the represented data */
124046
- ids: string[];
124047
- } | null;
124048
- reconciled?: {
124049
- /** @description Bank records linked through reconciliation */
124050
- bankRecordIds: string[];
124051
- } | null;
124052
- /** @description Listing statement-period conflicts for the represented data */
124053
- statementPeriod?: {
124054
- hits: {
124055
- /** Format: uuid */
124056
- listingId: string;
124057
- /** @description Posting date blocked by the statement period */
124058
- txnAt: string;
124059
- /** @description First open date for this listing period */
124060
- openFrom: string;
124061
- }[];
124062
- } | null;
124063
- } | null;
124064
- issues: ({
124065
- /** @constant */
124066
- code: "line_unassignedAccount";
124067
- /** @constant */
124068
- severity: "error";
124069
- context: Record<string, never>;
124070
- } | {
124071
- /** @constant */
124072
- code: "bankAccountLast4Mismatch";
124073
- /** @constant */
124074
- severity: "warning";
124075
- context: {
124076
- accountLast4: string;
124077
- transactionLast4: string;
124078
- };
124079
- })[];
124080
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
124081
- currency: string;
124082
- /** @description Value in cents (100 = 1€) */
124083
- amount: number;
124084
- recurringTemplate?: {
124085
- id: string;
124086
- } | null;
124087
- attachments: {
125902
+ paidStatus?: string | null;
125903
+ syncId: string | null;
125904
+ providerPayment: {
124088
125905
  /** Format: uuid */
124089
125906
  id: string;
124090
- transactionId: string | null;
125907
+ /** @constant */
125908
+ provider: "ramp";
125909
+ /** Format: uuid */
125910
+ connectionId: string;
125911
+ /** Format: uuid */
125912
+ transactionId: string;
125913
+ syncId: string | null;
125914
+ /** @enum {string} */
125915
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
125916
+ externalRef: string | null;
125917
+ failureReason: string | null;
125918
+ attemptId: string;
125919
+ attempt: number;
124091
125920
  /**
124092
125921
  * Format: date-time
124093
125922
  * @description Timestamp string with date, time, milliseconds, and timezone.
124094
125923
  * @example 2024-01-15T12:30:00.000+00:00
124095
125924
  */
124096
125925
  createdAt: string;
124097
- filename: string;
124098
- extension?: string | null;
124099
- contentType: string;
124100
- byteSize: number;
124101
- isOwnerAccessible: boolean;
124102
- }[];
124103
- account?: {
124104
- id: string;
124105
- name: string;
124106
- uniqueRef?: string | null;
124107
- /** @enum {string} */
124108
- status: "active" | "inactive";
124109
- } | null;
124110
- payment: {
124111
- /** @description Bank records reconciled to this transaction payment */
124112
- bankRecordIds: string[];
124113
125926
  /**
124114
- * @description Expense payment status
124115
- * @enum {string}
125927
+ * Format: date-time
125928
+ * @description Timestamp string with date, time, milliseconds, and timezone.
125929
+ * @example 2024-01-15T12:30:00.000+00:00
124116
125930
  */
124117
- status: "unpaid" | "underpaid" | "overpaid" | "paid";
124118
- lock?: {
124119
- /**
124120
- * @description Whether the represented entity or field can be mutated
124121
- * @enum {string}
124122
- */
124123
- status: "locked" | "unlocked";
124124
- /** @description Present when books closing blocks the mutation */
124125
- booksClosed?: {
124126
- /** @description First open accounting date */
124127
- date: string;
124128
- } | null;
124129
- /** @description Present when journal entries are attached to owner statements */
124130
- ownerStatement?: {
124131
- /** @description Owner statements that lock the represented data */
124132
- ids: string[];
124133
- } | null;
124134
- reconciled?: {
124135
- /** @description Bank records linked through reconciliation */
124136
- bankRecordIds: string[];
124137
- } | null;
124138
- /** @description Listing statement-period conflicts for the represented data */
124139
- statementPeriod?: {
124140
- hits: {
124141
- /** Format: uuid */
124142
- listingId: string;
124143
- /** @description Posting date blocked by the statement period */
124144
- txnAt: string;
124145
- /** @description First open date for this listing period */
124146
- openFrom: string;
124147
- }[];
124148
- } | null;
124149
- } | null;
124150
- date?: string | null;
124151
- };
124152
- connection?: {
124153
- /** Format: uuid */
124154
- id: string;
124155
- name: string;
124156
- /** @enum {string} */
124157
- status: "active" | "inactive";
124158
- uniqueRef?: string | null;
124159
- appId: string;
124160
- } | null;
124161
- contact?: {
124162
- /** Format: uuid */
124163
- id: string;
124164
- name?: string | null;
124165
- firstName?: string | null;
124166
- uniqueRef?: string | null;
124167
- shortRef?: string | null;
124168
- email?: string | null;
124169
- /** @enum {string} */
124170
- type: "owner" | "vendor";
124171
- } | null;
124172
- source?: {
124173
- /** Format: uuid */
124174
- id: string;
124175
- type: string;
124176
- status?: ("active" | "inactive") | null;
124177
- appId?: string | null;
124178
- appIcon?: string | null;
125931
+ updatedAt: string;
124179
125932
  } | null;
124180
- matchStatus?: string | null;
124181
- matchedByBankRule: boolean;
124182
125933
  };
124183
125934
  };
124184
125935
  };
@@ -124409,13 +126160,9 @@ export interface operations {
124409
126160
  };
124410
126161
  };
124411
126162
  };
124412
- deleteTransactionsById: {
126163
+ getTransactionsByIdProviderPayments: {
124413
126164
  parameters: {
124414
- query?: {
124415
- onLocked?: "error" | "archive";
124416
- /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
124417
- dryRun?: boolean;
124418
- };
126165
+ query?: never;
124419
126166
  header?: never;
124420
126167
  path: {
124421
126168
  id: string;
@@ -124431,8 +126178,35 @@ export interface operations {
124431
126178
  };
124432
126179
  content: {
124433
126180
  "application/json": {
124434
- /** @enum {string} */
124435
- status: "deleted" | "archived";
126181
+ data: {
126182
+ /** Format: uuid */
126183
+ id: string;
126184
+ /** @constant */
126185
+ provider: "ramp";
126186
+ /** Format: uuid */
126187
+ connectionId: string;
126188
+ /** Format: uuid */
126189
+ transactionId: string;
126190
+ syncId: string | null;
126191
+ /** @enum {string} */
126192
+ status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
126193
+ externalRef: string | null;
126194
+ failureReason: string | null;
126195
+ attemptId: string;
126196
+ attempt: number;
126197
+ /**
126198
+ * Format: date-time
126199
+ * @description Timestamp string with date, time, milliseconds, and timezone.
126200
+ * @example 2024-01-15T12:30:00.000+00:00
126201
+ */
126202
+ createdAt: string;
126203
+ /**
126204
+ * Format: date-time
126205
+ * @description Timestamp string with date, time, milliseconds, and timezone.
126206
+ * @example 2024-01-15T12:30:00.000+00:00
126207
+ */
126208
+ updatedAt: string;
126209
+ }[];
124436
126210
  };
124437
126211
  };
124438
126212
  };
@@ -124663,29 +126437,19 @@ export interface operations {
124663
126437
  };
124664
126438
  };
124665
126439
  };
124666
- postTransactionsByIdPay: {
126440
+ deleteTransactionsByIdProviderPaymentsByProviderPaymentId: {
124667
126441
  parameters: {
124668
- query?: {
124669
- /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
124670
- dryRun?: boolean;
124671
- };
126442
+ query?: never;
124672
126443
  header?: never;
124673
126444
  path: {
124674
126445
  id: string;
126446
+ providerPaymentId: string;
124675
126447
  };
124676
126448
  cookie?: never;
124677
126449
  };
124678
126450
  requestBody?: {
124679
126451
  content: {
124680
- "application/json": {
124681
- ramp: boolean;
124682
- date?: string | null;
124683
- vendor?: {
124684
- legalName?: string;
124685
- accountNumber?: string;
124686
- routingNumber?: string;
124687
- };
124688
- };
126452
+ "application/json": Record<string, never>;
124689
126453
  };
124690
126454
  };
124691
126455
  responses: {
@@ -124698,7 +126462,8 @@ export interface operations {
124698
126462
  "application/json": {
124699
126463
  /** Format: uuid */
124700
126464
  id: string;
124701
- paidStatus?: string | null;
126465
+ /** @constant */
126466
+ status: "deleted";
124702
126467
  };
124703
126468
  };
124704
126469
  };