Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.factset.sdk.FactSetFundamentalsReportBuilder.api;
import com.factset.sdk.FactSetFundamentalsReportBuilder.ApiException;
import com.factset.sdk.FactSetFundamentalsReportBuilder.ApiClient;
import com.factset.sdk.FactSetFundamentalsReportBuilder.ApiResponse;
import com.factset.sdk.FactSetFundamentalsReportBuilder.Configuration;
import com.factset.sdk.FactSetFundamentalsReportBuilder.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetFundamentalsReportBuilder.models.ErrorResponse;
import com.factset.sdk.FactSetFundamentalsReportBuilder.models.Response;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class FinancialsApi {
private ApiClient apiClient;
public FinancialsApi() {
this(Configuration.getDefaultApiClient());
}
public FinancialsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getFinancialsBalanceSheetResponseTypeMap = new HashMap();
static {
getFinancialsBalanceSheetResponseTypeMap.put(200, new GenericType(){});
getFinancialsBalanceSheetResponseTypeMap.put(400, new GenericType(){});
getFinancialsBalanceSheetResponseTypeMap.put(403, new GenericType(){});
getFinancialsBalanceSheetResponseTypeMap.put(404, new GenericType(){});
getFinancialsBalanceSheetResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getFinancialsCashFlowResponseTypeMap = new HashMap();
static {
getFinancialsCashFlowResponseTypeMap.put(200, new GenericType(){});
getFinancialsCashFlowResponseTypeMap.put(400, new GenericType(){});
getFinancialsCashFlowResponseTypeMap.put(403, new GenericType(){});
getFinancialsCashFlowResponseTypeMap.put(404, new GenericType(){});
getFinancialsCashFlowResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getFinancialsIncomeStatementResponseTypeMap = new HashMap();
static {
getFinancialsIncomeStatementResponseTypeMap.put(200, new GenericType(){});
getFinancialsIncomeStatementResponseTypeMap.put(400, new GenericType(){});
getFinancialsIncomeStatementResponseTypeMap.put(403, new GenericType(){});
getFinancialsIncomeStatementResponseTypeMap.put(404, new GenericType(){});
getFinancialsIncomeStatementResponseTypeMap.put(500, new GenericType(){});
}
/**
* Get the API client
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API client
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Balance Sheet
* Returns a standardized Balance Sheet based on industry.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to INTERIM)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @param reportStatus Return historical periods as originally reported or retroactively restated (for M&A, accounting changes, and other events). The following are descriptions for the accepted values: - RESTATED - retroactively restated data. - NON-RESTATED - originally reported data. (optional, default to RESTATED)
* @param currency Currency code for currency values. \"LOCAL\" will return the security's pricing currency. \"RPT\" will return the company's reporting currency (which may differ from \"LOCAL\" for some companies). For a list of other currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional, default to LOCAL)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getFinancialsBalanceSheet(String id, String periodicity, String schema, String reportStatus, String currency) throws ApiException {
return getFinancialsBalanceSheetWithHttpInfo(id, periodicity, schema, reportStatus, currency).getData();
}
/**
* Balance Sheet
* Returns a standardized Balance Sheet based on industry.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to INTERIM)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @param reportStatus Return historical periods as originally reported or retroactively restated (for M&A, accounting changes, and other events). The following are descriptions for the accepted values: - RESTATED - retroactively restated data. - NON-RESTATED - originally reported data. (optional, default to RESTATED)
* @param currency Currency code for currency values. \"LOCAL\" will return the security's pricing currency. \"RPT\" will return the company's reporting currency (which may differ from \"LOCAL\" for some companies). For a list of other currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional, default to LOCAL)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getFinancialsBalanceSheetWithHttpInfo(String id, String periodicity, String schema, String reportStatus, String currency) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getFinancialsBalanceSheet");
}
// create path and map variables
String localVarPath = "/balance-sheet";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "reportStatus", reportStatus));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "currency", currency));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
Response
> apiResponse = apiClient.invokeAPI("FinancialsApi.getFinancialsBalanceSheet", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getFinancialsBalanceSheetResponseTypeMap, false);
return apiResponse;
}
/**
* Cash Flow
* Returns a standardized Cash Flow based on industry.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to INTERIM)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @param reportStatus Return historical periods as originally reported or retroactively restated (for M&A, accounting changes, and other events). The following are descriptions for the accepted values: - RESTATED - retroactively restated data. - NON-RESTATED - originally reported data. (optional, default to RESTATED)
* @param currency Currency code for currency values. \"LOCAL\" will return the security's pricing currency. \"RPT\" will return the company's reporting currency (which may differ from \"LOCAL\" for some companies). For a list of other currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional, default to LOCAL)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getFinancialsCashFlow(String id, String periodicity, String schema, String reportStatus, String currency) throws ApiException {
return getFinancialsCashFlowWithHttpInfo(id, periodicity, schema, reportStatus, currency).getData();
}
/**
* Cash Flow
* Returns a standardized Cash Flow based on industry.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to INTERIM)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @param reportStatus Return historical periods as originally reported or retroactively restated (for M&A, accounting changes, and other events). The following are descriptions for the accepted values: - RESTATED - retroactively restated data. - NON-RESTATED - originally reported data. (optional, default to RESTATED)
* @param currency Currency code for currency values. \"LOCAL\" will return the security's pricing currency. \"RPT\" will return the company's reporting currency (which may differ from \"LOCAL\" for some companies). For a list of other currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional, default to LOCAL)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getFinancialsCashFlowWithHttpInfo(String id, String periodicity, String schema, String reportStatus, String currency) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getFinancialsCashFlow");
}
// create path and map variables
String localVarPath = "/cash-flow";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "reportStatus", reportStatus));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "currency", currency));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
Response
> apiResponse = apiClient.invokeAPI("FinancialsApi.getFinancialsCashFlow", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getFinancialsCashFlowResponseTypeMap, false);
return apiResponse;
}
/**
* Income Statement
* Returns a standardized Income Statement based on industry.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to INTERIM)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @param reportStatus Return historical periods as originally reported or retroactively restated (for M&A, accounting changes, and other events). The following are descriptions for the accepted values: - RESTATED - retroactively restated data. - NON-RESTATED - originally reported data. (optional, default to RESTATED)
* @param currency Currency code for currency values. \"LOCAL\" will return the security's pricing currency. \"RPT\" will return the company's reporting currency (which may differ from \"LOCAL\" for some companies). For a list of other currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional, default to LOCAL)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getFinancialsIncomeStatement(String id, String periodicity, String schema, String reportStatus, String currency) throws ApiException {
return getFinancialsIncomeStatementWithHttpInfo(id, periodicity, schema, reportStatus, currency).getData();
}
/**
* Income Statement
* Returns a standardized Income Statement based on industry.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to INTERIM)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @param reportStatus Return historical periods as originally reported or retroactively restated (for M&A, accounting changes, and other events). The following are descriptions for the accepted values: - RESTATED - retroactively restated data. - NON-RESTATED - originally reported data. (optional, default to RESTATED)
* @param currency Currency code for currency values. \"LOCAL\" will return the security's pricing currency. \"RPT\" will return the company's reporting currency (which may differ from \"LOCAL\" for some companies). For a list of other currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional, default to LOCAL)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* Api-Supported-Versions - Supported API major versions * Api-Version - API version (semantic versioning) * X-DataDirect-Request-Key - FactSet request ID
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getFinancialsIncomeStatementWithHttpInfo(String id, String periodicity, String schema, String reportStatus, String currency) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getFinancialsIncomeStatement");
}
// create path and map variables
String localVarPath = "/income-statement";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "reportStatus", reportStatus));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "currency", currency));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
Response
> apiResponse = apiClient.invokeAPI("FinancialsApi.getFinancialsIncomeStatement", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getFinancialsIncomeStatementResponseTypeMap, false);
return apiResponse;
}
}
