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