@invinite-org/data-api-client 2.0.0 → 3.0.0

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.
Files changed (94) hide show
  1. package/.openapi-generator/FILES +13 -2
  2. package/dist/apis/AsReportedBalanceSheetApi.d.ts +29 -2
  3. package/dist/apis/AsReportedBalanceSheetApi.js +33 -3
  4. package/dist/apis/AsReportedCashFlowStatementApi.d.ts +56 -2
  5. package/dist/apis/AsReportedCashFlowStatementApi.js +63 -3
  6. package/dist/apis/AsReportedIncomeStatementApi.d.ts +29 -2
  7. package/dist/apis/AsReportedIncomeStatementApi.js +33 -3
  8. package/dist/apis/AsReportedSnapshotApi.d.ts +59 -5
  9. package/dist/apis/AsReportedSnapshotApi.js +65 -5
  10. package/dist/esm/apis/AsReportedBalanceSheetApi.d.ts +29 -2
  11. package/dist/esm/apis/AsReportedBalanceSheetApi.js +32 -2
  12. package/dist/esm/apis/AsReportedCashFlowStatementApi.d.ts +56 -2
  13. package/dist/esm/apis/AsReportedCashFlowStatementApi.js +62 -2
  14. package/dist/esm/apis/AsReportedIncomeStatementApi.d.ts +29 -2
  15. package/dist/esm/apis/AsReportedIncomeStatementApi.js +32 -2
  16. package/dist/esm/apis/AsReportedSnapshotApi.d.ts +59 -5
  17. package/dist/esm/apis/AsReportedSnapshotApi.js +64 -4
  18. package/dist/esm/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts → AsReportedDetailedFact.d.ts} +39 -21
  19. package/dist/esm/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js → AsReportedDetailedFact.js} +33 -13
  20. package/dist/esm/models/AsReportedFact.d.ts +38 -0
  21. package/dist/esm/models/AsReportedFact.js +47 -0
  22. package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +3 -2
  23. package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +4 -2
  24. package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +3 -3
  25. package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +3 -3
  26. package/dist/esm/models/AsReportedSnapshot200Response.d.ts +33 -0
  27. package/dist/esm/models/AsReportedSnapshot200Response.js +44 -0
  28. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInner.d.ts +91 -0
  29. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInner.js +85 -0
  30. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
  31. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.js +52 -0
  32. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
  33. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +43 -0
  34. package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +3 -3
  35. package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +3 -3
  36. package/dist/esm/models/InsiderTradesList200ResponseTransactionsInner.d.ts +4 -4
  37. package/dist/esm/models/PresentationFact.d.ts +12 -0
  38. package/dist/esm/models/PresentationFact.js +4 -0
  39. package/dist/esm/models/index.d.ts +6 -1
  40. package/dist/esm/models/index.js +6 -1
  41. package/dist/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts → AsReportedDetailedFact.d.ts} +39 -21
  42. package/dist/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js → AsReportedDetailedFact.js} +38 -18
  43. package/dist/models/AsReportedFact.d.ts +38 -0
  44. package/dist/models/AsReportedFact.js +54 -0
  45. package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +3 -2
  46. package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +4 -2
  47. package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +3 -3
  48. package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +3 -3
  49. package/dist/models/AsReportedSnapshot200Response.d.ts +33 -0
  50. package/dist/models/AsReportedSnapshot200Response.js +51 -0
  51. package/dist/models/AsReportedSnapshot200ResponseCompaniesInner.d.ts +91 -0
  52. package/dist/models/AsReportedSnapshot200ResponseCompaniesInner.js +93 -0
  53. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
  54. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.js +59 -0
  55. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
  56. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +50 -0
  57. package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +3 -3
  58. package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +3 -3
  59. package/dist/models/InsiderTradesList200ResponseTransactionsInner.d.ts +4 -4
  60. package/dist/models/PresentationFact.d.ts +12 -0
  61. package/dist/models/PresentationFact.js +4 -0
  62. package/dist/models/index.d.ts +6 -1
  63. package/dist/models/index.js +6 -1
  64. package/docs/AsReportedBalanceSheetApi.md +15 -6
  65. package/docs/AsReportedCashFlowStatementApi.md +24 -6
  66. package/docs/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.md → AsReportedDetailedFact.md} +12 -6
  67. package/docs/AsReportedFact.md +36 -0
  68. package/docs/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.md +1 -1
  69. package/docs/AsReportedIncomeStatementApi.md +15 -6
  70. package/docs/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.md +1 -1
  71. package/docs/AsReportedSnapshot200Response.md +34 -0
  72. package/docs/AsReportedSnapshot200ResponseCompaniesInner.md +50 -0
  73. package/docs/AsReportedSnapshot200ResponseCompaniesInnerStatements.md +38 -0
  74. package/docs/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
  75. package/docs/AsReportedSnapshotApi.md +25 -7
  76. package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.md +1 -1
  77. package/docs/PresentationFact.md +4 -0
  78. package/package.json +1 -1
  79. package/src/apis/AsReportedBalanceSheetApi.ts +41 -2
  80. package/src/apis/AsReportedCashFlowStatementApi.ts +80 -2
  81. package/src/apis/AsReportedIncomeStatementApi.ts +41 -2
  82. package/src/apis/AsReportedSnapshotApi.ts +88 -10
  83. package/src/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.ts → AsReportedDetailedFact.ts} +59 -28
  84. package/src/models/AsReportedFact.ts +75 -0
  85. package/src/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.ts +12 -4
  86. package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.ts +10 -10
  87. package/src/models/AsReportedSnapshot200Response.ts +74 -0
  88. package/src/models/AsReportedSnapshot200ResponseCompaniesInner.ts +159 -0
  89. package/src/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.ts +92 -0
  90. package/src/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
  91. package/src/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.ts +10 -10
  92. package/src/models/InsiderTradesList200ResponseTransactionsInner.ts +4 -4
  93. package/src/models/PresentationFact.ts +16 -0
  94. package/src/models/index.ts +6 -1
@@ -33,6 +33,18 @@ export interface PresentationFact {
33
33
  * @memberof PresentationFact
34
34
  */
35
35
  value?: number | null;
36
+ /**
37
+ * Set with `value`: true when Invinite computed the value (Q4, TTM or YTD derivation), false = the company reported it
38
+ * @type {boolean}
39
+ * @memberof PresentationFact
40
+ */
41
+ derived?: boolean;
42
+ /**
43
+ * Set with `value`: the company's own caption of the line item (null when not extracted)
44
+ * @type {string}
45
+ * @memberof PresentationFact
46
+ */
47
+ company_label?: string | null;
36
48
  /**
37
49
  * Depth level in the tree structure (0 for root items)
38
50
  * @type {number}
@@ -41,6 +41,8 @@ function PresentationFactFromJSONTyped(json, ignoreDiscriminator) {
41
41
  'concept': json['concept'],
42
42
  'label': json['label'],
43
43
  'value': json['value'] == null ? undefined : json['value'],
44
+ 'derived': json['derived'] == null ? undefined : json['derived'],
45
+ 'company_label': json['company_label'] == null ? undefined : json['company_label'],
44
46
  'depth': json['depth'],
45
47
  'isTotal': json['isTotal'] == null ? undefined : json['isTotal'],
46
48
  'children': json['children'] == null ? undefined : (json['children'].map(PresentationFactFromJSON)),
@@ -57,6 +59,8 @@ function PresentationFactToJSONTyped(value, ignoreDiscriminator = false) {
57
59
  'concept': value['concept'],
58
60
  'label': value['label'],
59
61
  'value': value['value'],
62
+ 'derived': value['derived'],
63
+ 'company_label': value['company_label'],
60
64
  'depth': value['depth'],
61
65
  'isTotal': value['isTotal'],
62
66
  'children': value['children'] == null ? undefined : (value['children'].map(PresentationFactToJSON)),
@@ -4,16 +4,21 @@ export * from './AccountUsage200ResponseByKeyInner';
4
4
  export * from './AccountUsage200ResponseDailyInner';
5
5
  export * from './AccountUsage200ResponseDailyInnerErrors';
6
6
  export * from './AccountUsage200ResponsePeriod';
7
+ export * from './AsReportedDetailedFact';
8
+ export * from './AsReportedFact';
7
9
  export * from './AsReportedIncomeStatement200Response';
8
10
  export * from './AsReportedIncomeStatement200ResponseCompaniesInner';
9
11
  export * from './AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner';
10
12
  export * from './AsReportedIncomeStatementDetailed200Response';
11
13
  export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInner';
12
14
  export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner';
13
- export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue';
14
15
  export * from './AsReportedIncomeStatementPresentation200Response';
15
16
  export * from './AsReportedIncomeStatementPresentation200ResponseCompaniesInner';
16
17
  export * from './AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner';
18
+ export * from './AsReportedSnapshot200Response';
19
+ export * from './AsReportedSnapshot200ResponseCompaniesInner';
20
+ export * from './AsReportedSnapshot200ResponseCompaniesInnerStatements';
21
+ export * from './AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement';
17
22
  export * from './AsReportedSnapshotDetailed200Response';
18
23
  export * from './AsReportedSnapshotDetailed200ResponseCompaniesInner';
19
24
  export * from './AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements';
@@ -22,16 +22,21 @@ __exportStar(require("./AccountUsage200ResponseByKeyInner"), exports);
22
22
  __exportStar(require("./AccountUsage200ResponseDailyInner"), exports);
23
23
  __exportStar(require("./AccountUsage200ResponseDailyInnerErrors"), exports);
24
24
  __exportStar(require("./AccountUsage200ResponsePeriod"), exports);
25
+ __exportStar(require("./AsReportedDetailedFact"), exports);
26
+ __exportStar(require("./AsReportedFact"), exports);
25
27
  __exportStar(require("./AsReportedIncomeStatement200Response"), exports);
26
28
  __exportStar(require("./AsReportedIncomeStatement200ResponseCompaniesInner"), exports);
27
29
  __exportStar(require("./AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner"), exports);
28
30
  __exportStar(require("./AsReportedIncomeStatementDetailed200Response"), exports);
29
31
  __exportStar(require("./AsReportedIncomeStatementDetailed200ResponseCompaniesInner"), exports);
30
32
  __exportStar(require("./AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner"), exports);
31
- __exportStar(require("./AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue"), exports);
32
33
  __exportStar(require("./AsReportedIncomeStatementPresentation200Response"), exports);
33
34
  __exportStar(require("./AsReportedIncomeStatementPresentation200ResponseCompaniesInner"), exports);
34
35
  __exportStar(require("./AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner"), exports);
36
+ __exportStar(require("./AsReportedSnapshot200Response"), exports);
37
+ __exportStar(require("./AsReportedSnapshot200ResponseCompaniesInner"), exports);
38
+ __exportStar(require("./AsReportedSnapshot200ResponseCompaniesInnerStatements"), exports);
39
+ __exportStar(require("./AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement"), exports);
35
40
  __exportStar(require("./AsReportedSnapshotDetailed200Response"), exports);
36
41
  __exportStar(require("./AsReportedSnapshotDetailed200ResponseCompaniesInner"), exports);
37
42
  __exportStar(require("./AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements"), exports);
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.data.invinite.com*
12
12
 
13
13
  ## asReportedBalanceSheet
14
14
 
15
- > AsReportedIncomeStatement200Response asReportedBalanceSheet(identifier, fiscalPeriodType, sort, limit, offset)
15
+ > AsReportedIncomeStatement200Response asReportedBalanceSheet(identifier, fiscalPeriodType, sort, limit, offset, reportedOnly)
16
16
 
17
17
  As-reported balance sheet
18
18
 
@@ -46,6 +46,8 @@ async function example() {
46
46
  limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
48
  offset: 0,
49
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
50
+ reportedOnly: true,
49
51
  } satisfies AsReportedBalanceSheetRequest;
50
52
 
51
53
  try {
@@ -70,6 +72,7 @@ example().catch(console.error);
70
72
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
71
73
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
72
74
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
75
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
73
76
 
74
77
  ### Return type
75
78
 
@@ -99,11 +102,11 @@ example().catch(console.error);
99
102
 
100
103
  ## asReportedBalanceSheetDetailed
101
104
 
102
- > AsReportedIncomeStatementDetailed200Response asReportedBalanceSheetDetailed(identifier, fiscalPeriodType, sort, limit, offset, withFormula)
105
+ > AsReportedIncomeStatementDetailed200Response asReportedBalanceSheetDetailed(identifier, fiscalPeriodType, sort, limit, offset, withFormula, reportedOnly)
103
106
 
104
107
  As-reported balance sheet (detailed)
105
108
 
106
- Fetch detailed as-reported balance sheet data with html_label, formula, accession number, and html tag info. Minimum tier for redistribute: PRO.
109
+ Fetch detailed as-reported balance sheet data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
107
110
 
108
111
  ### Example
109
112
 
@@ -133,8 +136,10 @@ async function example() {
133
136
  limit: 5,
134
137
  // number | Number of periods to skip for pagination (optional)
135
138
  offset: 0,
136
- // 'true' | 'false' | Include formula in response (optional)
139
+ // 'true' | 'false' | Include each derived fact\'s formula (its members and their values) (optional)
137
140
  withFormula: true,
141
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
142
+ reportedOnly: true,
138
143
  } satisfies AsReportedBalanceSheetDetailedRequest;
139
144
 
140
145
  try {
@@ -159,7 +164,8 @@ example().catch(console.error);
159
164
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
160
165
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
161
166
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
162
- | **withFormula** | `true`, `false` | Include formula in response | [Optional] [Defaults to `'false'`] [Enum: true, false] |
167
+ | **withFormula** | `true`, `false` | Include each derived fact\'s formula (its members and their values) | [Optional] [Defaults to `'false'`] [Enum: true, false] |
168
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
163
169
 
164
170
  ### Return type
165
171
 
@@ -189,7 +195,7 @@ example().catch(console.error);
189
195
 
190
196
  ## asReportedBalanceSheetPresentation
191
197
 
192
- > AsReportedIncomeStatementPresentation200Response asReportedBalanceSheetPresentation(identifier, fiscalPeriodType, sort, limit, offset)
198
+ > AsReportedIncomeStatementPresentation200Response asReportedBalanceSheetPresentation(identifier, fiscalPeriodType, sort, limit, offset, reportedOnly)
193
199
 
194
200
  As-reported balance sheet (presentation)
195
201
 
@@ -223,6 +229,8 @@ async function example() {
223
229
  limit: 5,
224
230
  // number | Number of periods to skip for pagination (optional)
225
231
  offset: 0,
232
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
233
+ reportedOnly: true,
226
234
  } satisfies AsReportedBalanceSheetPresentationRequest;
227
235
 
228
236
  try {
@@ -247,6 +255,7 @@ example().catch(console.error);
247
255
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
248
256
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
249
257
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
258
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
250
259
 
251
260
  ### Return type
252
261
 
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.data.invinite.com*
12
12
 
13
13
  ## asReportedCashFlowStatement
14
14
 
15
- > AsReportedIncomeStatement200Response asReportedCashFlowStatement(identifier, fiscalPeriodType, sort, limit, offset)
15
+ > AsReportedIncomeStatement200Response asReportedCashFlowStatement(identifier, fiscalPeriodType, sort, limit, offset, reportedOnly, displaySign)
16
16
 
17
17
  As-reported cash flow statement
18
18
 
@@ -46,6 +46,10 @@ async function example() {
46
46
  limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
48
  offset: 0,
49
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
50
+ reportedOnly: true,
51
+ // 'as_filed' | 'cash_flow_direction' | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). (optional)
52
+ displaySign: as_filed,
49
53
  } satisfies AsReportedCashFlowStatementRequest;
50
54
 
51
55
  try {
@@ -70,6 +74,8 @@ example().catch(console.error);
70
74
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
71
75
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
72
76
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
77
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
78
+ | **displaySign** | `as_filed`, `cash_flow_direction` | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). | [Optional] [Defaults to `'as_filed'`] [Enum: as_filed, cash_flow_direction] |
73
79
 
74
80
  ### Return type
75
81
 
@@ -99,11 +105,11 @@ example().catch(console.error);
99
105
 
100
106
  ## asReportedCashFlowStatementDetailed
101
107
 
102
- > AsReportedIncomeStatementDetailed200Response asReportedCashFlowStatementDetailed(identifier, fiscalPeriodType, sort, limit, offset, withFormula)
108
+ > AsReportedIncomeStatementDetailed200Response asReportedCashFlowStatementDetailed(identifier, fiscalPeriodType, sort, limit, offset, withFormula, reportedOnly, displaySign)
103
109
 
104
110
  As-reported cash flow statement (detailed)
105
111
 
106
- Fetch detailed as-reported cash flow statement data with html_label, formula, accession number, and html tag info. Minimum tier for redistribute: PRO.
112
+ Fetch detailed as-reported cash flow statement data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
107
113
 
108
114
  ### Example
109
115
 
@@ -133,8 +139,12 @@ async function example() {
133
139
  limit: 5,
134
140
  // number | Number of periods to skip for pagination (optional)
135
141
  offset: 0,
136
- // 'true' | 'false' | Include formula in response (optional)
142
+ // 'true' | 'false' | Include each derived fact\'s formula (its members and their values) (optional)
137
143
  withFormula: true,
144
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
145
+ reportedOnly: true,
146
+ // 'as_filed' | 'cash_flow_direction' | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). (optional)
147
+ displaySign: as_filed,
138
148
  } satisfies AsReportedCashFlowStatementDetailedRequest;
139
149
 
140
150
  try {
@@ -159,7 +169,9 @@ example().catch(console.error);
159
169
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
160
170
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
161
171
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
162
- | **withFormula** | `true`, `false` | Include formula in response | [Optional] [Defaults to `'false'`] [Enum: true, false] |
172
+ | **withFormula** | `true`, `false` | Include each derived fact\'s formula (its members and their values) | [Optional] [Defaults to `'false'`] [Enum: true, false] |
173
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
174
+ | **displaySign** | `as_filed`, `cash_flow_direction` | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). | [Optional] [Defaults to `'as_filed'`] [Enum: as_filed, cash_flow_direction] |
163
175
 
164
176
  ### Return type
165
177
 
@@ -189,7 +201,7 @@ example().catch(console.error);
189
201
 
190
202
  ## asReportedCashFlowStatementPresentation
191
203
 
192
- > AsReportedIncomeStatementPresentation200Response asReportedCashFlowStatementPresentation(identifier, fiscalPeriodType, sort, limit, offset)
204
+ > AsReportedIncomeStatementPresentation200Response asReportedCashFlowStatementPresentation(identifier, fiscalPeriodType, sort, limit, offset, reportedOnly, displaySign)
193
205
 
194
206
  As-reported cash flow statement (presentation)
195
207
 
@@ -223,6 +235,10 @@ async function example() {
223
235
  limit: 5,
224
236
  // number | Number of periods to skip for pagination (optional)
225
237
  offset: 0,
238
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
239
+ reportedOnly: true,
240
+ // 'as_filed' | 'cash_flow_direction' | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). (optional)
241
+ displaySign: as_filed,
226
242
  } satisfies AsReportedCashFlowStatementPresentationRequest;
227
243
 
228
244
  try {
@@ -247,6 +263,8 @@ example().catch(console.error);
247
263
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
248
264
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
249
265
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
266
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
267
+ | **displaySign** | `as_filed`, `cash_flow_direction` | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). | [Optional] [Defaults to `'as_filed'`] [Enum: as_filed, cash_flow_direction] |
250
268
 
251
269
  ### Return type
252
270
 
@@ -1,5 +1,5 @@
1
1
 
2
- # AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
2
+ # AsReportedDetailedFact
3
3
 
4
4
 
5
5
  ## Properties
@@ -7,7 +7,10 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `value` | number
10
- `html_label` | string
10
+ `derived` | boolean
11
+ `label` | string
12
+ `company_label` | string
13
+ `decimals` | number
11
14
  `formula` | [StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula](StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.md)
12
15
  `accession_number` | string
13
16
  `html_tag_id` | string
@@ -15,16 +18,19 @@ Name | Type
15
18
  ## Example
16
19
 
17
20
  ```typescript
18
- import type { AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue } from '@invinite-org/data-api-client'
21
+ import type { AsReportedDetailedFact } from '@invinite-org/data-api-client'
19
22
 
20
23
  // TODO: Update the object below with actual values
21
24
  const example = {
22
25
  "value": null,
23
- "html_label": null,
26
+ "derived": null,
27
+ "label": null,
28
+ "company_label": null,
29
+ "decimals": null,
24
30
  "formula": null,
25
31
  "accession_number": null,
26
32
  "html_tag_id": null,
27
- } satisfies AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
33
+ } satisfies AsReportedDetailedFact
28
34
 
29
35
  console.log(example)
30
36
 
@@ -33,7 +39,7 @@ const exampleJSON: string = JSON.stringify(example)
33
39
  console.log(exampleJSON)
34
40
 
35
41
  // Parse the JSON string back to an object
36
- const exampleParsed = JSON.parse(exampleJSON) as AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
42
+ const exampleParsed = JSON.parse(exampleJSON) as AsReportedDetailedFact
37
43
  console.log(exampleParsed)
38
44
  ```
39
45
 
@@ -0,0 +1,36 @@
1
+
2
+ # AsReportedFact
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `value` | number
10
+ `derived` | boolean
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { AsReportedFact } from '@invinite-org/data-api-client'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "value": null,
20
+ "derived": null,
21
+ } satisfies AsReportedFact
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as AsReportedFact
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -12,7 +12,7 @@ Name | Type
12
12
  `calendar_quarter` | number
13
13
  `fiscal_period_type` | string
14
14
  `period_end` | Date
15
- `facts` | { [key: string]: number; }
15
+ `facts` | [{ [key: string]: AsReportedFact; }](AsReportedFact.md)
16
16
 
17
17
  ## Example
18
18
 
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.data.invinite.com*
12
12
 
13
13
  ## asReportedIncomeStatement
14
14
 
15
- > AsReportedIncomeStatement200Response asReportedIncomeStatement(identifier, fiscalPeriodType, sort, limit, offset)
15
+ > AsReportedIncomeStatement200Response asReportedIncomeStatement(identifier, fiscalPeriodType, sort, limit, offset, reportedOnly)
16
16
 
17
17
  As-reported income statement
18
18
 
@@ -46,6 +46,8 @@ async function example() {
46
46
  limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
48
  offset: 0,
49
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
50
+ reportedOnly: true,
49
51
  } satisfies AsReportedIncomeStatementRequest;
50
52
 
51
53
  try {
@@ -70,6 +72,7 @@ example().catch(console.error);
70
72
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
71
73
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
72
74
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
75
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
73
76
 
74
77
  ### Return type
75
78
 
@@ -99,11 +102,11 @@ example().catch(console.error);
99
102
 
100
103
  ## asReportedIncomeStatementDetailed
101
104
 
102
- > AsReportedIncomeStatementDetailed200Response asReportedIncomeStatementDetailed(identifier, fiscalPeriodType, sort, limit, offset, withFormula)
105
+ > AsReportedIncomeStatementDetailed200Response asReportedIncomeStatementDetailed(identifier, fiscalPeriodType, sort, limit, offset, withFormula, reportedOnly)
103
106
 
104
107
  As-reported income statement (detailed)
105
108
 
106
- Fetch detailed as-reported income statement data with html_label, formula, accession number, and html tag info. Minimum tier for redistribute: PRO.
109
+ Fetch detailed as-reported income statement data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
107
110
 
108
111
  ### Example
109
112
 
@@ -133,8 +136,10 @@ async function example() {
133
136
  limit: 5,
134
137
  // number | Number of periods to skip for pagination (optional)
135
138
  offset: 0,
136
- // 'true' | 'false' | Include formula in response (optional)
139
+ // 'true' | 'false' | Include each derived fact\'s formula (its members and their values) (optional)
137
140
  withFormula: true,
141
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
142
+ reportedOnly: true,
138
143
  } satisfies AsReportedIncomeStatementDetailedRequest;
139
144
 
140
145
  try {
@@ -159,7 +164,8 @@ example().catch(console.error);
159
164
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
160
165
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
161
166
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
162
- | **withFormula** | `true`, `false` | Include formula in response | [Optional] [Defaults to `'false'`] [Enum: true, false] |
167
+ | **withFormula** | `true`, `false` | Include each derived fact\'s formula (its members and their values) | [Optional] [Defaults to `'false'`] [Enum: true, false] |
168
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
163
169
 
164
170
  ### Return type
165
171
 
@@ -189,7 +195,7 @@ example().catch(console.error);
189
195
 
190
196
  ## asReportedIncomeStatementPresentation
191
197
 
192
- > AsReportedIncomeStatementPresentation200Response asReportedIncomeStatementPresentation(identifier, fiscalPeriodType, sort, limit, offset)
198
+ > AsReportedIncomeStatementPresentation200Response asReportedIncomeStatementPresentation(identifier, fiscalPeriodType, sort, limit, offset, reportedOnly)
193
199
 
194
200
  As-reported income statement (presentation)
195
201
 
@@ -223,6 +229,8 @@ async function example() {
223
229
  limit: 5,
224
230
  // number | Number of periods to skip for pagination (optional)
225
231
  offset: 0,
232
+ // 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
233
+ reportedOnly: true,
226
234
  } satisfies AsReportedIncomeStatementPresentationRequest;
227
235
 
228
236
  try {
@@ -247,6 +255,7 @@ example().catch(console.error);
247
255
  | **sort** | `asc`, `desc` | Sort direction for periods by period_end | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
248
256
  | **limit** | `number` | Maximum number of periods per ticker | [Optional] [Defaults to `10`] |
249
257
  | **offset** | `number` | Number of periods to skip for pagination | [Optional] [Defaults to `0`] |
258
+ | **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
250
259
 
251
260
  ### Return type
252
261
 
@@ -12,7 +12,7 @@ Name | Type
12
12
  `calendar_quarter` | number
13
13
  `fiscal_period_type` | string
14
14
  `period_end` | Date
15
- `facts` | [{ [key: string]: AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue; }](AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.md)
15
+ `facts` | [{ [key: string]: AsReportedDetailedFact; }](AsReportedDetailedFact.md)
16
16
 
17
17
  ## Example
18
18
 
@@ -0,0 +1,34 @@
1
+
2
+ # AsReportedSnapshot200Response
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `companies` | [Array<AsReportedSnapshot200ResponseCompaniesInner>](AsReportedSnapshot200ResponseCompaniesInner.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AsReportedSnapshot200Response } from '@invinite-org/data-api-client'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "companies": null,
19
+ } satisfies AsReportedSnapshot200Response
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as AsReportedSnapshot200Response
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,50 @@
1
+
2
+ # AsReportedSnapshot200ResponseCompaniesInner
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `ticker` | string
10
+ `cik` | string
11
+ `fiscal_year` | number
12
+ `fiscal_quarter` | number
13
+ `calendar_year` | number
14
+ `calendar_quarter` | number
15
+ `fiscal_period_type` | string
16
+ `period_end` | Date
17
+ `statements` | [AsReportedSnapshot200ResponseCompaniesInnerStatements](AsReportedSnapshot200ResponseCompaniesInnerStatements.md)
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { AsReportedSnapshot200ResponseCompaniesInner } from '@invinite-org/data-api-client'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "ticker": null,
27
+ "cik": null,
28
+ "fiscal_year": null,
29
+ "fiscal_quarter": null,
30
+ "calendar_year": null,
31
+ "calendar_quarter": null,
32
+ "fiscal_period_type": null,
33
+ "period_end": null,
34
+ "statements": null,
35
+ } satisfies AsReportedSnapshot200ResponseCompaniesInner
36
+
37
+ console.log(example)
38
+
39
+ // Convert the instance to a JSON string
40
+ const exampleJSON: string = JSON.stringify(example)
41
+ console.log(exampleJSON)
42
+
43
+ // Parse the JSON string back to an object
44
+ const exampleParsed = JSON.parse(exampleJSON) as AsReportedSnapshot200ResponseCompaniesInner
45
+ console.log(exampleParsed)
46
+ ```
47
+
48
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
49
+
50
+
@@ -0,0 +1,38 @@
1
+
2
+ # AsReportedSnapshot200ResponseCompaniesInnerStatements
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `income_statement` | [AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement](AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md)
10
+ `balance_sheet` | [AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement](AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md)
11
+ `cash_flow_statement` | [AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement](AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md)
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { AsReportedSnapshot200ResponseCompaniesInnerStatements } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "income_statement": null,
21
+ "balance_sheet": null,
22
+ "cash_flow_statement": null,
23
+ } satisfies AsReportedSnapshot200ResponseCompaniesInnerStatements
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as AsReportedSnapshot200ResponseCompaniesInnerStatements
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,35 @@
1
+
2
+ # AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement
3
+
4
+ Latest income statement facts or null if not available
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `facts` | [{ [key: string]: AsReportedFact; }](AsReportedFact.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement } from '@invinite-org/data-api-client'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "facts": null,
20
+ } satisfies AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement
21
+
22
+ console.log(example)
23
+
24
+ // Convert the instance to a JSON string
25
+ const exampleJSON: string = JSON.stringify(example)
26
+ console.log(exampleJSON)
27
+
28
+ // Parse the JSON string back to an object
29
+ const exampleParsed = JSON.parse(exampleJSON) as AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement
30
+ console.log(exampleParsed)
31
+ ```
32
+
33
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
34
+
35
+