Note: There is a newer version (0.2.1) of this package available. Click here to view docs for the latest version.
Module candid.essentials
ballerinax/candid.essentials Ballerina library
0.0.1
Clients
candid.essentials: Client
Isolated
Search GuideStar’s most common set of data about nonprofits to quickly find organizations most relevant to your users, and use those results to get more data from our other APIs. API returns search result in JSON format.
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.candid.org/essentials" - URL of the target service
post v1
Isolated FunctionResource Function
function post v1(Query payload) returns V1EssentialsResponse|error/essentials/v1
Parameters
- payload Query - Below JSON request body is an example showing all available elements. Please use the examples from the API Documentation.
Return Type
post v2
Isolated FunctionResource Function
function post v2(Query payload) returns V2EssentialsResponse|error/essentials/v2
Parameters
- payload Query - Below JSON request body is an example showing all available elements. Please use the examples from the API Documentation.
Return Type
post v3
Isolated FunctionResource Function
function post v3(V3Query payload) returns V3EssentialsResponse|error/essentials/v3
Parameters
- payload V3Query - Below JSON request body is an example showing all available elements. Please use the examples from the API Documentation.
Return Type
get lookup
Isolated FunctionResource Function
function get lookup() returns EssentialsLookupResponse|error/essentials/lookup
Return Type
get lookup/[string filter_name]
Isolated FunctionResource Function
function get lookup/[string filter_name]() returns EssentialsFilteredLookupResponse|error/essentials/lookup/{filter_name}
Return Type
get lookup/[string filter_name]/[string key_or_value]
Isolated FunctionResource Function
function get lookup/[string filter_name]/[string key_or_value]() returns EssentialsFilteredLookupResponse|error/essentials/lookup/{filter_name}/{key_or_value}
Return Type
Records
candid.essentials: AffiliationTypeFilter
Fields
- parent boolean? - Flag indicating the organization is a parent. Value set as true or false.
- subordinate boolean? - Flag indicating the organization is a subordinate. Value set as true or false.
- independent boolean? - Flag indicating the organization is independent. Value set as true or false.
- headquarter boolean? - Flag indicating the organization is a headquarter. Value set as true or false.
candid.essentials: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- subscriptionKey string -
candid.essentials: AuditsFilter
Fields
- a_133_audit_performed boolean? - Flag indicating the organization performed A-133 audit. Value set as true or false.
candid.essentials: BadRequest
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
candid.essentials: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
candid.essentials: EssentialsFilteredLookupResponse
Fields
- code int? - HTTP response status code.
- message string? -
- took int? -
- errors string[]? -
- data EssentialsFilteredLookupResponse_data[]? - A list of all the tables used as a filter_name with the Essentials Lookup endpoints
candid.essentials: EssentialsFilteredLookupResponse_data
Key value pair for filter name, value, and search_value
Fields
- 'key string? - Code for the filter_name results
- value string? - Text for the filter_name results
- search_value string? - Value to pass in Essential's API filters
candid.essentials: EssentialsLookupResponse
Fields
- code int? - Response Code
- message string? - Diagnostic message for response status
- took int? - Time taken for request to process
- errors string[]? - List of errors encountered
- data string[]? -
candid.essentials: Filters
Fields
- geography GeographyFilter? -
- organization OrganizationFilter? -
- financials FinancialsFilter? -
candid.essentials: FinancialsFilter
Fields
- total_revenue NumberRangeFilter? -
- total_expenses NumberRangeFilter? -
- total_assets NumberRangeFilter? -
candid.essentials: Forbidden
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: GeographyFilter
Fields
- state string[]? -
- zip string? - Five digit ZIP code
- radius int? - Radius from the specified ZIP code in miles. Allowed range is between 1 and 50 miles. Values exceeding 50 will default to a radius of 50 miles.
- msa string[]? -
- city string[]? -
- county string[]? -
candid.essentials: InternalServerError
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: IrsFormTypesFilter
Fields
- f990 boolean? - Flag indicating the organization files a form 990. Value set as true or false.
- f990pf boolean? - Flag indicating the organization files a form 990-PF. Value set as true or false.
- f990ez boolean? - Flag indicating the organization files a form 990 EZ. Value set as true or false.
- f990n boolean? - Flag indicating the organization files a form 990N. Value set as true or false.
- required_to_file_990t boolean? - Flag indicating the organization is required to file a 990-T. Value set as true or false.
candid.essentials: LastUpdated
Fields
- start_date string? - A filter, along with end_date, defines a range on date_type, in the format yyyy-MM-ddTHH:mm:ss.
- end_date string? - A filter, along with start_date, defines a range on date_type, in the format yyyy-MM-ddTHH:mm:ss.
- date_type "seal_last_modified"|"profile_last_modified"|"dei_last_modified"|"financials_last_modified"|"last_modified" ? - A filter, to specify updates made to a organization over the specified end_date and start_date.
candid.essentials: NotAcceptable
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: NotFound
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: NumberRangeFilter
Fields
- min int? - Minimum number
- max int? - Maximum number
candid.essentials: OrganizationFilter
Fields
- profile_levels string[]? - GuideStar seal levels, comma separated.
- ntee_major_codes string[]? - National Taxonomy of Exempt Entities (NTEE) major codes, comma separated.
- ntee_minor_codes string[]? - National Taxonomy of Exempt Entities (NTEE) minor codes, comma separated.
- subsection_codes string[]? - IRS subsection codes and/or descriptions, comma separated.
- foundation_codes string[]? - Foundation codes and/or descriptions, comma separated.
- bmf_status boolean? - Flag indicating the organization has the most recent IRS BMF. Defaults to null. Otherwise true or false.
- pub78_verified boolean? - Flag indicating the organization is pub78 verified. Value set as true or false.
- affiliation_type AffiliationTypeFilter? -
- specific_exclusions SpecificExclusionsFilter? -
- number_of_employees_range NumberRangeFilter? -
- form_types IrsFormTypesFilter? -
- audits AuditsFilter? -
candid.essentials: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
candid.essentials: Query
Fields
- search_terms string? - Can be any string you'd like to search on, including EIN, organization name, keywords, etc.
- 'from int? - The offset from the first result. Defaults to 0.
- size int? - The maximum number of hits to be returned. Defaults to 25. The maximum number allowed is 25.
- sort Sort? -
- filters Filters? -
candid.essentials: Sort
Fields
- sort_by "organization_name"|"bmf_gross_receipts"|"bmf_assets" ? - Leave blank to sort by relevance.
- 'ascending boolean? - Default value is true (ascending). Set to false to sort by descending value.
candid.essentials: SpecificExclusionsFilter
Fields
- exclude_revoked_organizations boolean? - Flag to exclude revoked organizations. Value set as true or false.
- exclude_defunct_or_merged_organizations boolean? - Flag to exclude defunct or merged organizations. Value set as true or false.
candid.essentials: TooManyRequests
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: Unauthorized
Fields
- code string? - HTTP response status code.
- message string? -
candid.essentials: V1EssentialsResponse
Fields
- code int? - Response Code
- message string? - Diagnostic message for response status
- took int? - Time taken for request to process
- errors string[]? - List of errors encountered
- data V1EssentialsResponse_data? -
candid.essentials: V1EssentialsResponse_data
Fields
- took int? - Elapsed time to calculate results
- total_hits int? - Number of results returned by search
- hits V1EssentialsResponse_data_hits[]? -
candid.essentials: V1EssentialsResponse_data_hits
Fields
- organization_id string? - A unique number identifying organizations and organizational entities
- bridge_id string? - Deprecated Bridge ID
- ein string? - Employer Identification Number
- organization_name string? - The public name recognized by the IRS
- also_known_as string? - Organization name Also Known As
- mission string? - Mission statement for the organization
- address_line_1 string? - Address line 1 of the organization
- address_line_2 string? - Address line 2 of the organization
- city string? - City of the organization's address
- state string? - State (Abbreviation) of the organization's address
- zip string? - Zip code of the organization's address
- county string? - County of the organization's address
- msa string? - Metropolitan statistical area of the organization's adresss
- lat_long string? - latitude and longitude of the organization's adress
- ntee_code string? - National Taxonomy of Exempt Entities
- profile_level "BRONZE"|"SILVER"|"GOLD"|"PLATINUM"|"NONE" ? - GuideStar seal levels.
- public_report string? - GuideStar's public profile URL
- subsection_code string? - IRS subsection code of the organization
- number_of_employees string? - Number of employees at the organization
- form_type string? - Tax form filing type.
- website_url string? - URL for the organization's website
- foundation_code string? - Foundation code that describes the organization
- parent_orgs string? - Names of parent organizations, comma seperated
- bmf_gross_receipts string? - Gross receipts of the organization reported on the BMF
- bmf_assets string? - Assets of the organization reported on the BMF
- form990_total_revenue string? - Total revenue filed on the most recent Form 990, 990-PF, or 990-EZ filing
- form990_total_expenses string? - Total expenses filed on the most recent Form 990, 990-PF, or 990-EZ filing
- form990_total_assets string? - Total assets filed on the most recent Form 990, 990-PF, or 990-EZ filing
- contact_email string? - Email of the primary contact at the organization
- contact_name string? - Name of the primary contact at the organization
- contact_phone string? - Phone number of the primary contact at the organization
- contact_title string? - Title of the primary contact at the organization
- properties V1EssentialsResponse_data_properties? -
candid.essentials: V1EssentialsResponse_data_properties
Fields
- parent boolean? - If the organization is a parent
- subordinate boolean? - If the organization is a subordinate
- independent boolean? - If the organization is independent
- national_hq boolean? - If the organization is a national headquarter
- revoked boolean? - If the organization is revoked
- defuncted_or_merged boolean? - If the organization is defuncted or merged
- audit_a133_performed boolean? - If the organization performed a A-133 audit
- bmf_status boolean? - If the organization is present on the BMF
- pub78_verified boolean? - If the organization is Pub78 verified
- allow_online_giving boolean? - If the organization allows online giving
candid.essentials: V2EssentialsResponse
Fields
- code int? - Response Code
- message string? - Diagnostic message for response status
- took int? - Time taken for request to process
- errors string[]? - List of errors encountered
- data V2EssentialsResponse_data? -
candid.essentials: V2EssentialsResponse_data
Fields
- took int? - Elapsed time to calculate results
- total_hits int? - Number of results returned by search
- hits V2EssentialsResponse_data_hits[]? -
candid.essentials: V2EssentialsResponse_data_hits
Fields
- organization_id string? - A unique number identifying organizations and organizational entities
- bridge_id string? - Deprecated Bridge ID
- ein string? - Employer Identification Number
- organization_name string? - The public name recognized by the IRS
- also_known_as string? - Organization name Also Known As
- mission string? - Mission statement for the organization
- address_line_1 string? - Address line 1 of the organization
- address_line_2 string? - Address line 2 of the organization
- city string? - City of the organization's address
- state string? - State (Abbreviation) of the organization's address
- zip string? - Zip code of the organization's address
- county string? - County of the organization's address
- msa string? - Metropolitan statistical area of the organization's adresss
- lat_long string? - latitude and longitude of the organization's adress
- ntee_code string? - National Taxonomy of Exempt Entities
- profile_level "BRONZE"|"SILVER"|"GOLD"|"PLATINUM"|"NONE" ? - GuideStar seal levels.
- public_report string? - GuideStar's public profile URL
- subsection_code string? - IRS subsection code of the organization
- number_of_employees string? - Number of employees at the organization
- form_type string? - Tax form filing type.
- website_url string? - URL for the organization's website
- logo_url string? - URL for the organization's logo
- foundation_code string? - Foundation code that describes the organization
- parent_orgs string? - Names of parent organizations, comma seperated
- bmf_gross_receipts string? - Gross receipts of the organization reported on the BMF
- bmf_assets string? - Assets of the organization reported on the BMF
- form990_total_revenue string? - Total revenue filed on the most recent Form 990, 990-PF, or 990-EZ filing
- form990_total_expenses string? - Total expenses filed on the most recent Form 990, 990-PF, or 990-EZ filing
- form990_total_assets string? - Total assets filed on the most recent Form 990, 990-PF, or 990-EZ filing
- contact_email string? - Email of the primary contact at the organization
- contact_name string? - Name of the primary contact at the organization
- contact_phone string? - Phone number of the primary contact at the organization
- contact_title string? - Title of the primary contact at the organization
- properties V1EssentialsResponse_data_properties? -
candid.essentials: V3EssentialsResponse
Fields
- code int? - Response Code
- message string? - Diagnostic message for response status
- took int? - Time taken for request to process
- time string? - Time of API call.
- results_count int? - Number of results returned by search
- page_count int? - Number of pages returned by the search.
- errors string[]? - List of errors encountered
- hits V3EssentialsResponse_hits[]? -
candid.essentials: V3EssentialsResponse_dates
Fields
- seal_last_modified string? - Date when Candid seal status was last modified.
- profile_last_modified string? - Datetime of last update to Candid profile.
- dei_last_modified string? - Datetime of last update to organization demographics information
- financials_last_modified string? - Datetime of last update to organization's financial information
- last_published string? - Datetime of organization's last publication
candid.essentials: V3EssentialsResponse_financials
Fields
- most_recent_year V3EssentialsResponse_financials_most_recent_year? -
- bmf_gross_receipts decimal? - Gross receipts of the organization reported on the BMF
- bmf_assets decimal? - Assets of the organization reported on the BMF
- required_to_file_990t boolean? - Flag indicating the organization is required to file a 990-T.
- a_133_audit_performed boolean? - Flag indicating the organization performed A-133 audit.
candid.essentials: V3EssentialsResponse_financials_most_recent_year
Fields
- form_types string? - Tax form filing type
- fiscal_year decimal? - Fiscal year of the most recent tax filing
- total_revenue decimal? - Most recent year total revenue
- total_expenses decimal? - Most recent year total expenses
- total_assets decimal? - Most recent year total assets
candid.essentials: V3EssentialsResponse_geography
Fields
- address_line_1 string? - Address line 1 of the organization
- address_line_2 string? - Address line 2 of the organization
- city string? - City of the organization's address
- state string? - State (Abbreviation) of the organization's address
- msa string? - Metropolitan statistical area of the organization's adresss
- congressional_district string? - Congressional district of the organization's address
- county string? - County of the organization's address
- latitude decimal? - latitude of the organization's adress
- longitude decimal? - longitude of the organization's adress
candid.essentials: V3EssentialsResponse_hits
Fields
- organization V3EssentialsResponse_organization? -
- properties V3EssentialsResponse_properties? -
- geography V3EssentialsResponse_geography? -
- taxonomies V3EssentialsResponse_taxonomies? -
- financials V3EssentialsResponse_financials? -
- dates V3EssentialsResponse_dates? -
candid.essentials: V3EssentialsResponse_organization
Fields
- organization_id string? - A unique number identifying organizations and organizational entities
- ein string? - Employer Identification Number
- organization_name string? - The public name recognized by the IRS
- also_known_as string? - Organization name Also Known As
- group_exemption string? - Four-digit number assigned to a group of organizations falling under a central/parent organization holding group exemption letters.
- mission string? - Mission statement for the organization
- website_url string? - URL for the organization's website
- logo_url string? - URL for the organization's logo
- profile_level string? - GuideStar seal level
- profile_year decimal? - GuideStar seal year
- profile_link string? - GuideStar's public profile URL
- profile_logo string? - GuideStar's seal logo
- leader_name string? - Name of leader
- leader_title string? - Leader's title
- contact_name string? - Name of the primary contact at the organization
- contact_email string? - Email of the primary contact at the organization
- contact_phone string? - Phone number of the primary contact at the organization
- contact_title string? - Title of the primary contact at the organization
- ruling_year decimal? - The year the IRS granted organization tax exempt status (a.k.a. Ruling Year)
candid.essentials: V3EssentialsResponse_properties
Fields
- bmf_status boolean? - If the organization is present on the BMF
- pub78_verified boolean? - If the organization is Pub78 verified
- allow_online_giving boolean? - If the organization allows online giving
- dei_submitted boolean? - If the organization has submitted demographics information
- revoked boolean? - If the organization is revoked
- defuncted_or_merged boolean? - If the organization is defuncted or merged
- relationship_type V3EssentialsResponse_properties_relationship_type? -
- relationship_details V3EssentialsResponse_properties_relationship_details? - Organization's relation with other organizations.
candid.essentials: V3EssentialsResponse_properties_relationship_details
Organization's relation with other organizations.
Fields
- relationship_type "parent"|"subordinate" ? - Relationship type of organization.
- organization_name string? - Name of organization.
- ein string? - Employer Identification Number
candid.essentials: V3EssentialsResponse_properties_relationship_type
Fields
- parent boolean? - If the organization is a parent
- subordinate boolean? - If the organization is a subordinate
- independent boolean? - If the organization is independent
- headquarters boolean? - If the organization is a national headquarter
candid.essentials: V3EssentialsResponse_taxonomies
Fields
- subject_codes V3EssentialsResponse_taxonomies_subject_codes[]? -
- population_served_codes V3EssentialsResponse_taxonomies_population_served_codes[]? -
- ntee_codes V3EssentialsResponse_taxonomies_ntee_codes[]? -
- subsection_code V3EssentialsResponse_taxonomies_subsection_code? -
- foundation_code V3EssentialsResponse_taxonomies_foundation_code? -
candid.essentials: V3EssentialsResponse_taxonomies_foundation_code
Fields
- foundation_code string? - Foundation code that describes the organization
- foundation_code_description string? - Description of foundation code
candid.essentials: V3EssentialsResponse_taxonomies_ntee_codes
Fields
- ntee_code string? - National Taxonomy of Exempt Entities
- ntee_code_description string? - Description of NTEE code
candid.essentials: V3EssentialsResponse_taxonomies_population_served_codes
Fields
- population_served_code string? - Population served code
- population_served_description string? - Description of Population served code
candid.essentials: V3EssentialsResponse_taxonomies_subject_codes
Fields
- subject_code string? - Subject code
- subject_code_description string? - Description of subject code
candid.essentials: V3EssentialsResponse_taxonomies_subsection_code
Fields
- subsection_code string? - IRS subsection code of the organization
- subsection_code_description string? - Description of IRS subsection code
candid.essentials: V3Filters
Fields
- geography GeographyFilter? -
- organization V3OrganizationFilter? -
- financials V3FinancialsFilter? -
- last_updated LastUpdated? -
candid.essentials: V3FinancialsFilter
Fields
- most_recent_year V3FinancialsFilter_most_recent_year? -
- required_to_file_990t boolean? - Flag indicating the organization is required to file a 990-T. Value set as true or false.
- a_133_audit_performed boolean? - Flag indicating the organization performed A-133 audit. Value set as true or false.
candid.essentials: V3FinancialsFilter_most_recent_year
Fields
- form_types V3FinancialsFilter_most_recent_year_form_types? -
- total_revenue NumberRangeFilter? -
- total_expenses NumberRangeFilter? -
- total_assets NumberRangeFilter? -
candid.essentials: V3FinancialsFilter_most_recent_year_form_types
Fields
- f990 boolean? - Flag indicating the organization files a form 990. Value set as true or false.
- f990pf boolean? - Flag indicating the organization files a form 990-PF. Value set as true or false.
- f990ez boolean? - Flag indicating the organization files a form 990ez. Value set as true or false.
- f990n boolean? - Flag indicating the organization files a form 990n. Value set as true or false.
candid.essentials: V3OrganizationFilter
Fields
- profile_levels string[]? - GuideStar seal levels, comma separated.
- subject_codes string[]? - Subject codes, comma separated.
- population_served_codes string[]? - Population served codes, comma separated.
- ntee_major_codes string[]? - National Taxonomy of Exempt Entities (NTEE) major codes, comma separated.
- ntee_minor_codes string[]? - National Taxonomy of Exempt Entities (NTEE) minor codes, comma separated.
- subsection_codes string[]? - IRS subsection codes and/or descriptions, comma separated.
- foundation_codes string[]? - Foundation codes and/or descriptions, comma separated.
- group_exemption string[]? - Group exemption codes, comma separated.
- number_of_employees NumberRangeFilter? -
- ruling_year NumberRangeFilter? -
- properties V3OrgProperties? -
candid.essentials: V3OrgProperties
Fields
- bmf_status boolean? - Flag indicating the organization has the most recent IRS BMF. Defaults to null. Otherwise true or false.
- pub78_verified boolean? - Flag indicating the organization is pub78 verified. Value set as true or false.
- allow_online_giving boolean? - Flag indicating the organization allows online giving. Value set as true or false.
- dei_submitted boolean? - Flag indicating the organization has submitted demographics information. Value set as true or false.
- exclude_revoked_organizations boolean? - Flag to exclude revoked organizations. Value set as true or false.
- exclude_defunct_or_merged_organizations boolean? - Flag to exclude defunct or merged organizations. Value set as true or false.
- relationship_type AffiliationTypeFilter? -
candid.essentials: V3Query
Fields
- search_terms string? - Can be any string you'd like to search on, including EIN, organization name, keywords, etc.
- 'from int? - The offset from the first result. Defaults to 0.
- size int? - The maximum number of hits to be returned. Defaults to 25. The maximum number allowed is 25.
- sort V3Sort? -
- filters V3Filters? -
candid.essentials: V3Sort
Fields
- sort_by "organization_name"|"bmf_gross_receipts"|"bmf_assets"|"distance"|"year_founded" ? - Leave blank to sort by relevance.
- sort_order "asc"|"desc" ? - Default value is ascending. Allowed values are "asc" (ascending) and "desc" (descending).