@vrplatform/api 1.3.1-stage.2096 → 1.3.1-stage.2098
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.
|
@@ -74,6 +74,40 @@ export interface paths {
|
|
|
74
74
|
patch?: never;
|
|
75
75
|
trace?: never;
|
|
76
76
|
};
|
|
77
|
+
"/accounts/{id}/connect-bank-account": {
|
|
78
|
+
parameters: {
|
|
79
|
+
query?: never;
|
|
80
|
+
header?: never;
|
|
81
|
+
path?: never;
|
|
82
|
+
cookie?: never;
|
|
83
|
+
};
|
|
84
|
+
get?: never;
|
|
85
|
+
put?: never;
|
|
86
|
+
/** @description Connect a bank account to an account */
|
|
87
|
+
post: operations["postAccountsByIdConnectBankAccount"];
|
|
88
|
+
delete?: never;
|
|
89
|
+
options?: never;
|
|
90
|
+
head?: never;
|
|
91
|
+
patch?: never;
|
|
92
|
+
trace?: never;
|
|
93
|
+
};
|
|
94
|
+
"/accounts/{id}/disconnect-bank-account": {
|
|
95
|
+
parameters: {
|
|
96
|
+
query?: never;
|
|
97
|
+
header?: never;
|
|
98
|
+
path?: never;
|
|
99
|
+
cookie?: never;
|
|
100
|
+
};
|
|
101
|
+
get?: never;
|
|
102
|
+
put?: never;
|
|
103
|
+
/** @description Disconnect a bank account from an account */
|
|
104
|
+
post: operations["postAccountsByIdDisconnectBankAccount"];
|
|
105
|
+
delete?: never;
|
|
106
|
+
options?: never;
|
|
107
|
+
head?: never;
|
|
108
|
+
patch?: never;
|
|
109
|
+
trace?: never;
|
|
110
|
+
};
|
|
77
111
|
"/accounts/{id}/recalculate-balances": {
|
|
78
112
|
parameters: {
|
|
79
113
|
query?: never;
|
|
@@ -3240,6 +3274,7 @@ export interface operations {
|
|
|
3240
3274
|
connections: {
|
|
3241
3275
|
id: string;
|
|
3242
3276
|
name: string;
|
|
3277
|
+
startDate?: string | null;
|
|
3243
3278
|
connection?: {
|
|
3244
3279
|
id: string;
|
|
3245
3280
|
appId: string;
|
|
@@ -3452,6 +3487,7 @@ export interface operations {
|
|
|
3452
3487
|
connections: {
|
|
3453
3488
|
id: string;
|
|
3454
3489
|
name: string;
|
|
3490
|
+
startDate?: string | null;
|
|
3455
3491
|
connection?: {
|
|
3456
3492
|
id: string;
|
|
3457
3493
|
appId: string;
|
|
@@ -3746,6 +3782,7 @@ export interface operations {
|
|
|
3746
3782
|
connections: {
|
|
3747
3783
|
id: string;
|
|
3748
3784
|
name: string;
|
|
3785
|
+
startDate?: string | null;
|
|
3749
3786
|
connection?: {
|
|
3750
3787
|
id: string;
|
|
3751
3788
|
appId: string;
|
|
@@ -3950,6 +3987,7 @@ export interface operations {
|
|
|
3950
3987
|
connections: {
|
|
3951
3988
|
id: string;
|
|
3952
3989
|
name: string;
|
|
3990
|
+
startDate?: string | null;
|
|
3953
3991
|
connection?: {
|
|
3954
3992
|
id: string;
|
|
3955
3993
|
appId: string;
|
|
@@ -4564,6 +4602,401 @@ export interface operations {
|
|
|
4564
4602
|
};
|
|
4565
4603
|
};
|
|
4566
4604
|
};
|
|
4605
|
+
postAccountsByIdConnectBankAccount: {
|
|
4606
|
+
parameters: {
|
|
4607
|
+
query?: never;
|
|
4608
|
+
header?: never;
|
|
4609
|
+
path: {
|
|
4610
|
+
id: string;
|
|
4611
|
+
};
|
|
4612
|
+
cookie?: never;
|
|
4613
|
+
};
|
|
4614
|
+
requestBody?: {
|
|
4615
|
+
content: {
|
|
4616
|
+
"application/json": {
|
|
4617
|
+
/** Format: uuid */
|
|
4618
|
+
bankAccountId: string;
|
|
4619
|
+
startDate: string;
|
|
4620
|
+
/**
|
|
4621
|
+
* @default error
|
|
4622
|
+
* @enum {string}
|
|
4623
|
+
*/
|
|
4624
|
+
onConflict?: "error" | "replace" | "replace-and-detach-history";
|
|
4625
|
+
};
|
|
4626
|
+
};
|
|
4627
|
+
};
|
|
4628
|
+
responses: {
|
|
4629
|
+
/** @description Successful response */
|
|
4630
|
+
200: {
|
|
4631
|
+
headers: {
|
|
4632
|
+
[name: string]: unknown;
|
|
4633
|
+
};
|
|
4634
|
+
content: {
|
|
4635
|
+
"application/json": {
|
|
4636
|
+
name: string;
|
|
4637
|
+
/** @enum {string} */
|
|
4638
|
+
status?: "active" | "inactive";
|
|
4639
|
+
/** @enum {string} */
|
|
4640
|
+
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
4641
|
+
uniqueRef?: string | null;
|
|
4642
|
+
id: string;
|
|
4643
|
+
offsetAccount?: {
|
|
4644
|
+
id: string;
|
|
4645
|
+
name: string;
|
|
4646
|
+
uniqueRef?: string | null;
|
|
4647
|
+
/** @enum {string} */
|
|
4648
|
+
status: "active" | "inactive";
|
|
4649
|
+
} | null;
|
|
4650
|
+
assignments: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "transfer_ownerPayout" | "transfer")[];
|
|
4651
|
+
category?: {
|
|
4652
|
+
id: string;
|
|
4653
|
+
name: string;
|
|
4654
|
+
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
4655
|
+
} | null;
|
|
4656
|
+
categoryLock: {
|
|
4657
|
+
/** @constant */
|
|
4658
|
+
status: "locked";
|
|
4659
|
+
/** @constant */
|
|
4660
|
+
reason: "immutable";
|
|
4661
|
+
};
|
|
4662
|
+
issues: {
|
|
4663
|
+
/** @constant */
|
|
4664
|
+
code: "bankAccountLast4OutOfSync";
|
|
4665
|
+
/** @constant */
|
|
4666
|
+
severity: "warning";
|
|
4667
|
+
context: {
|
|
4668
|
+
accountLast4?: string | null;
|
|
4669
|
+
bankAccountLast4: string;
|
|
4670
|
+
bankAccountIds: string[];
|
|
4671
|
+
};
|
|
4672
|
+
}[];
|
|
4673
|
+
banking?: {
|
|
4674
|
+
category?: ("trust" | "operating" | "external") | null;
|
|
4675
|
+
type?: ("deposit" | "creditCard") | null;
|
|
4676
|
+
last4?: string | null;
|
|
4677
|
+
currency?: string | null;
|
|
4678
|
+
connections: {
|
|
4679
|
+
id: string;
|
|
4680
|
+
name: string;
|
|
4681
|
+
startDate?: string | null;
|
|
4682
|
+
connection?: {
|
|
4683
|
+
id: string;
|
|
4684
|
+
appId: string;
|
|
4685
|
+
name: string;
|
|
4686
|
+
/** @enum {string} */
|
|
4687
|
+
status: "active" | "inactive";
|
|
4688
|
+
isErrorState: boolean;
|
|
4689
|
+
icon?: string | null;
|
|
4690
|
+
} | null;
|
|
4691
|
+
status?: ("active" | "inactive") | null;
|
|
4692
|
+
currentSync?: {
|
|
4693
|
+
/** @enum {string} */
|
|
4694
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
4695
|
+
createdAt: string;
|
|
4696
|
+
updatedAt: string;
|
|
4697
|
+
message?: string | null;
|
|
4698
|
+
} | null;
|
|
4699
|
+
source?: {
|
|
4700
|
+
/** Format: uuid */
|
|
4701
|
+
id: string;
|
|
4702
|
+
type: string;
|
|
4703
|
+
status?: ("active" | "inactive") | null;
|
|
4704
|
+
} | null;
|
|
4705
|
+
}[];
|
|
4706
|
+
bankRecords: {
|
|
4707
|
+
reconciled: number;
|
|
4708
|
+
unreconciled: number;
|
|
4709
|
+
total: number;
|
|
4710
|
+
latestCreatedAt?: string | null;
|
|
4711
|
+
};
|
|
4712
|
+
balance?: {
|
|
4713
|
+
openingDate?: string | null;
|
|
4714
|
+
opening: number;
|
|
4715
|
+
ending: number;
|
|
4716
|
+
} | null;
|
|
4717
|
+
} | null;
|
|
4718
|
+
};
|
|
4719
|
+
};
|
|
4720
|
+
};
|
|
4721
|
+
/** @description Bad request */
|
|
4722
|
+
400: {
|
|
4723
|
+
headers: {
|
|
4724
|
+
[name: string]: unknown;
|
|
4725
|
+
};
|
|
4726
|
+
content: {
|
|
4727
|
+
"application/json": {
|
|
4728
|
+
code: string;
|
|
4729
|
+
message: string;
|
|
4730
|
+
issues?: {
|
|
4731
|
+
message: string;
|
|
4732
|
+
}[];
|
|
4733
|
+
context?: unknown;
|
|
4734
|
+
};
|
|
4735
|
+
};
|
|
4736
|
+
};
|
|
4737
|
+
/** @description Unauthorized */
|
|
4738
|
+
401: {
|
|
4739
|
+
headers: {
|
|
4740
|
+
[name: string]: unknown;
|
|
4741
|
+
};
|
|
4742
|
+
content: {
|
|
4743
|
+
"application/json": {
|
|
4744
|
+
code: string;
|
|
4745
|
+
message: string;
|
|
4746
|
+
issues?: {
|
|
4747
|
+
message: string;
|
|
4748
|
+
}[];
|
|
4749
|
+
context?: unknown;
|
|
4750
|
+
};
|
|
4751
|
+
};
|
|
4752
|
+
};
|
|
4753
|
+
/** @description Forbidden */
|
|
4754
|
+
403: {
|
|
4755
|
+
headers: {
|
|
4756
|
+
[name: string]: unknown;
|
|
4757
|
+
};
|
|
4758
|
+
content: {
|
|
4759
|
+
"application/json": {
|
|
4760
|
+
code: string;
|
|
4761
|
+
message: string;
|
|
4762
|
+
issues?: {
|
|
4763
|
+
message: string;
|
|
4764
|
+
}[];
|
|
4765
|
+
context?: unknown;
|
|
4766
|
+
};
|
|
4767
|
+
};
|
|
4768
|
+
};
|
|
4769
|
+
/** @description Not found */
|
|
4770
|
+
404: {
|
|
4771
|
+
headers: {
|
|
4772
|
+
[name: string]: unknown;
|
|
4773
|
+
};
|
|
4774
|
+
content: {
|
|
4775
|
+
"application/json": {
|
|
4776
|
+
code: string;
|
|
4777
|
+
message: string;
|
|
4778
|
+
issues?: {
|
|
4779
|
+
message: string;
|
|
4780
|
+
}[];
|
|
4781
|
+
context?: unknown;
|
|
4782
|
+
};
|
|
4783
|
+
};
|
|
4784
|
+
};
|
|
4785
|
+
/** @description Internal server error */
|
|
4786
|
+
500: {
|
|
4787
|
+
headers: {
|
|
4788
|
+
[name: string]: unknown;
|
|
4789
|
+
};
|
|
4790
|
+
content: {
|
|
4791
|
+
"application/json": {
|
|
4792
|
+
code: string;
|
|
4793
|
+
message: string;
|
|
4794
|
+
issues?: {
|
|
4795
|
+
message: string;
|
|
4796
|
+
}[];
|
|
4797
|
+
context?: unknown;
|
|
4798
|
+
};
|
|
4799
|
+
};
|
|
4800
|
+
};
|
|
4801
|
+
};
|
|
4802
|
+
};
|
|
4803
|
+
postAccountsByIdDisconnectBankAccount: {
|
|
4804
|
+
parameters: {
|
|
4805
|
+
query?: never;
|
|
4806
|
+
header?: never;
|
|
4807
|
+
path: {
|
|
4808
|
+
id: string;
|
|
4809
|
+
};
|
|
4810
|
+
cookie?: never;
|
|
4811
|
+
};
|
|
4812
|
+
requestBody?: {
|
|
4813
|
+
content: {
|
|
4814
|
+
"application/json": {
|
|
4815
|
+
/** Format: uuid */
|
|
4816
|
+
bankAccountId: string;
|
|
4817
|
+
/**
|
|
4818
|
+
* @default preserve-history
|
|
4819
|
+
* @enum {string}
|
|
4820
|
+
*/
|
|
4821
|
+
mode?: "preserve-history" | "detach-history";
|
|
4822
|
+
};
|
|
4823
|
+
};
|
|
4824
|
+
};
|
|
4825
|
+
responses: {
|
|
4826
|
+
/** @description Successful response */
|
|
4827
|
+
200: {
|
|
4828
|
+
headers: {
|
|
4829
|
+
[name: string]: unknown;
|
|
4830
|
+
};
|
|
4831
|
+
content: {
|
|
4832
|
+
"application/json": {
|
|
4833
|
+
name: string;
|
|
4834
|
+
/** @enum {string} */
|
|
4835
|
+
status?: "active" | "inactive";
|
|
4836
|
+
/** @enum {string} */
|
|
4837
|
+
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
4838
|
+
uniqueRef?: string | null;
|
|
4839
|
+
id: string;
|
|
4840
|
+
offsetAccount?: {
|
|
4841
|
+
id: string;
|
|
4842
|
+
name: string;
|
|
4843
|
+
uniqueRef?: string | null;
|
|
4844
|
+
/** @enum {string} */
|
|
4845
|
+
status: "active" | "inactive";
|
|
4846
|
+
} | null;
|
|
4847
|
+
assignments: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "transfer_ownerPayout" | "transfer")[];
|
|
4848
|
+
category?: {
|
|
4849
|
+
id: string;
|
|
4850
|
+
name: string;
|
|
4851
|
+
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
4852
|
+
} | null;
|
|
4853
|
+
categoryLock: {
|
|
4854
|
+
/** @constant */
|
|
4855
|
+
status: "locked";
|
|
4856
|
+
/** @constant */
|
|
4857
|
+
reason: "immutable";
|
|
4858
|
+
};
|
|
4859
|
+
issues: {
|
|
4860
|
+
/** @constant */
|
|
4861
|
+
code: "bankAccountLast4OutOfSync";
|
|
4862
|
+
/** @constant */
|
|
4863
|
+
severity: "warning";
|
|
4864
|
+
context: {
|
|
4865
|
+
accountLast4?: string | null;
|
|
4866
|
+
bankAccountLast4: string;
|
|
4867
|
+
bankAccountIds: string[];
|
|
4868
|
+
};
|
|
4869
|
+
}[];
|
|
4870
|
+
banking?: {
|
|
4871
|
+
category?: ("trust" | "operating" | "external") | null;
|
|
4872
|
+
type?: ("deposit" | "creditCard") | null;
|
|
4873
|
+
last4?: string | null;
|
|
4874
|
+
currency?: string | null;
|
|
4875
|
+
connections: {
|
|
4876
|
+
id: string;
|
|
4877
|
+
name: string;
|
|
4878
|
+
startDate?: string | null;
|
|
4879
|
+
connection?: {
|
|
4880
|
+
id: string;
|
|
4881
|
+
appId: string;
|
|
4882
|
+
name: string;
|
|
4883
|
+
/** @enum {string} */
|
|
4884
|
+
status: "active" | "inactive";
|
|
4885
|
+
isErrorState: boolean;
|
|
4886
|
+
icon?: string | null;
|
|
4887
|
+
} | null;
|
|
4888
|
+
status?: ("active" | "inactive") | null;
|
|
4889
|
+
currentSync?: {
|
|
4890
|
+
/** @enum {string} */
|
|
4891
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
4892
|
+
createdAt: string;
|
|
4893
|
+
updatedAt: string;
|
|
4894
|
+
message?: string | null;
|
|
4895
|
+
} | null;
|
|
4896
|
+
source?: {
|
|
4897
|
+
/** Format: uuid */
|
|
4898
|
+
id: string;
|
|
4899
|
+
type: string;
|
|
4900
|
+
status?: ("active" | "inactive") | null;
|
|
4901
|
+
} | null;
|
|
4902
|
+
}[];
|
|
4903
|
+
bankRecords: {
|
|
4904
|
+
reconciled: number;
|
|
4905
|
+
unreconciled: number;
|
|
4906
|
+
total: number;
|
|
4907
|
+
latestCreatedAt?: string | null;
|
|
4908
|
+
};
|
|
4909
|
+
balance?: {
|
|
4910
|
+
openingDate?: string | null;
|
|
4911
|
+
opening: number;
|
|
4912
|
+
ending: number;
|
|
4913
|
+
} | null;
|
|
4914
|
+
} | null;
|
|
4915
|
+
};
|
|
4916
|
+
};
|
|
4917
|
+
};
|
|
4918
|
+
/** @description Bad request */
|
|
4919
|
+
400: {
|
|
4920
|
+
headers: {
|
|
4921
|
+
[name: string]: unknown;
|
|
4922
|
+
};
|
|
4923
|
+
content: {
|
|
4924
|
+
"application/json": {
|
|
4925
|
+
code: string;
|
|
4926
|
+
message: string;
|
|
4927
|
+
issues?: {
|
|
4928
|
+
message: string;
|
|
4929
|
+
}[];
|
|
4930
|
+
context?: unknown;
|
|
4931
|
+
};
|
|
4932
|
+
};
|
|
4933
|
+
};
|
|
4934
|
+
/** @description Unauthorized */
|
|
4935
|
+
401: {
|
|
4936
|
+
headers: {
|
|
4937
|
+
[name: string]: unknown;
|
|
4938
|
+
};
|
|
4939
|
+
content: {
|
|
4940
|
+
"application/json": {
|
|
4941
|
+
code: string;
|
|
4942
|
+
message: string;
|
|
4943
|
+
issues?: {
|
|
4944
|
+
message: string;
|
|
4945
|
+
}[];
|
|
4946
|
+
context?: unknown;
|
|
4947
|
+
};
|
|
4948
|
+
};
|
|
4949
|
+
};
|
|
4950
|
+
/** @description Forbidden */
|
|
4951
|
+
403: {
|
|
4952
|
+
headers: {
|
|
4953
|
+
[name: string]: unknown;
|
|
4954
|
+
};
|
|
4955
|
+
content: {
|
|
4956
|
+
"application/json": {
|
|
4957
|
+
code: string;
|
|
4958
|
+
message: string;
|
|
4959
|
+
issues?: {
|
|
4960
|
+
message: string;
|
|
4961
|
+
}[];
|
|
4962
|
+
context?: unknown;
|
|
4963
|
+
};
|
|
4964
|
+
};
|
|
4965
|
+
};
|
|
4966
|
+
/** @description Not found */
|
|
4967
|
+
404: {
|
|
4968
|
+
headers: {
|
|
4969
|
+
[name: string]: unknown;
|
|
4970
|
+
};
|
|
4971
|
+
content: {
|
|
4972
|
+
"application/json": {
|
|
4973
|
+
code: string;
|
|
4974
|
+
message: string;
|
|
4975
|
+
issues?: {
|
|
4976
|
+
message: string;
|
|
4977
|
+
}[];
|
|
4978
|
+
context?: unknown;
|
|
4979
|
+
};
|
|
4980
|
+
};
|
|
4981
|
+
};
|
|
4982
|
+
/** @description Internal server error */
|
|
4983
|
+
500: {
|
|
4984
|
+
headers: {
|
|
4985
|
+
[name: string]: unknown;
|
|
4986
|
+
};
|
|
4987
|
+
content: {
|
|
4988
|
+
"application/json": {
|
|
4989
|
+
code: string;
|
|
4990
|
+
message: string;
|
|
4991
|
+
issues?: {
|
|
4992
|
+
message: string;
|
|
4993
|
+
}[];
|
|
4994
|
+
context?: unknown;
|
|
4995
|
+
};
|
|
4996
|
+
};
|
|
4997
|
+
};
|
|
4998
|
+
};
|
|
4999
|
+
};
|
|
4567
5000
|
postAccountsByIdRecalculateBalances: {
|
|
4568
5001
|
parameters: {
|
|
4569
5002
|
query?: never;
|
|
@@ -6106,6 +6539,7 @@ export interface operations {
|
|
|
6106
6539
|
lastDigits?: string | null;
|
|
6107
6540
|
status?: ("active" | "inactive") | null;
|
|
6108
6541
|
accountId?: string | null;
|
|
6542
|
+
startDate?: string | null;
|
|
6109
6543
|
}[];
|
|
6110
6544
|
};
|
|
6111
6545
|
};
|
|
@@ -6240,6 +6674,7 @@ export interface operations {
|
|
|
6240
6674
|
lastDigits?: string | null;
|
|
6241
6675
|
status?: ("active" | "inactive") | null;
|
|
6242
6676
|
accountId?: string | null;
|
|
6677
|
+
startDate?: string | null;
|
|
6243
6678
|
};
|
|
6244
6679
|
};
|
|
6245
6680
|
};
|
|
@@ -6262,6 +6697,7 @@ export interface operations {
|
|
|
6262
6697
|
currency?: string | null;
|
|
6263
6698
|
lastDigits?: string | null;
|
|
6264
6699
|
status: ("active" | "inactive") | null;
|
|
6700
|
+
startDate?: string | null;
|
|
6265
6701
|
account?: {
|
|
6266
6702
|
id: string;
|
|
6267
6703
|
name: string;
|