webservices/docs.py
"""Narrative API documentation."""
BEGINNING_IMAGE_NUMBER = '''
Unique identifier for the electronic or paper report. This number is used to construct
PDF URLs to the original document.
'''
CANDIDATE_ID = '''
A unique identifier assigned to each candidate registered with the FEC.
If a person runs for several offices, that person will have separate candidate IDs for each office.
'''
COMMITTEE_ID = '''
A unique identifier assigned to each committee or filer registered with the FEC. In general \
committee id's begin with the letter C which is followed by eight digits.
'''
CANDIDATE_CYCLE = '''
Two-year election cycle in which a candidate runs for office.
Calculated from FEC Form 2. The cycle begins with
an odd year and is named for its ending, even year. This cycle follows
the traditional house election cycle and subdivides the presidential
and Senate elections into comparable two-year blocks. To see data for
the entire four years of a presidential term or six years of a senatorial term,
you will need the `election_full` flag.
'''
COMMITTEE_CYCLE = '''
A two year election cycle that the committee was active- (after original registration
date but before expiration date in FEC Form 1s) The cycle begins with
an odd year and is named for its ending, even year.
'''
RECORD_CYCLE = '''
Filter records to only those that were applicable to a given
two-year period.The cycle begins with an odd year and is named
for its ending, even year.
'''
RECORD_YEAR = '''
Filter records to only those that were applicable to a given year.
'''
# committee uses a different definition for cycle because it is less straight forward
CYCLE = '''
Filter records to only those that are applicable to a given two-year
period. This cycle follows the traditional House election cycle and
subdivides the presidential and Senate elections into comparable
two-year blocks. The cycle begins with an odd year and is named for its
ending, even year.
'''
API_DESCRIPTION = '''
This API allows you to explore the way candidates and committees fund their campaigns.
The FEC API is a RESTful web service supporting full-text and field-specific searches on
FEC data. [Bulk downloads](http://fec.gov/data/DataCatalog.do) are available on the current
site. Information is tied to the underlying forms by file ID and image ID. Data is updated
nightly.
There is a lot of data, but a good place to start is to use search to find
interesting candidates and committees. Then, you can use their IDs to find report or line
item details with the other endpoints. If you are interested in individual donors, check
out contributor information in schedule_a.
Get an [API key here](https://api.data.gov/signup/). That will enable you to place up to 1,000
calls an hour. Each call is limited to 100 results per page. You can email questions, comments or
a request to get a key for 120 calls per minute to[APIinfo@fec.gov](apiinfo@fec.gov). You can also
ask questions and discuss the data in the [FEC data Google Group](https://groups.google.com/forum/#!forum/fec-data).
API changes will also be added to this group in advance of the change.
The model definitions and schema are available at [/swagger](/swagger/). This is useful for
making wrappers and exploring the data.
A few restrictions limit the way you can use FEC data. For example, you can’t use contributor
lists for commercial purposes or to solicit donations.
[Learn more here](https://transition.fec.gov/pages/brochures/saleuse.shtml).
[View our source code](https://github.com/fecgov/openFEC). We welcome issues and pull requests!
'''
CANDIDATE_TAG = '''
Candidate endpoints give you access to information about the people running for office.
This information is organized by candidate_id. If you're unfamiliar with candidate IDs,
using `/candidates/search` will help you locate a particular candidate.
Officially, a candidate is an individual seeking nomination for election to a federal
office. People become candidates when they (or agents working on their behalf)
raise contributions or make expenditures that exceed $5,000.
The candidate endpoints primarily use data from FEC registration
[Form 1](http://www.fec.gov/pdf/forms/fecfrm1.pdf), for candidate information, and
[Form 2](http://www.fec.gov/pdf/forms/fecfrm2.pdf), for committee information.
'''
NAME_SEARCH = '''
Search for candidates or committees by name. If you're looking for information on a
particular person or group, using a name to find the `candidate_id` or `committee_id` on
this endpoint can be a helpful first step.
'''
LEGAL_SEARCH = '''
Search for legal documents.
'''
CANDIDATE_LIST = '''
Fetch basic information about candidates, and use parameters to filter results to the
candidates you're looking for.
Each result reflects a unique FEC candidate ID. That ID is particular to the candidate for a
particular office sought. If a candidate runs for the same office multiple times, the ID
stays the same. If the same person runs for another office — for example, a House
candidate runs for a Senate office — that candidate will get a unique ID for each office.
'''
CANDIDATE_HISTORY = '''
Find out a candidate's characteristics over time. This is particularly useful if the
candidate runs for the same office in different districts or you want to know more about a candidate's
previous races.
This information is organized by `candidate_id`, so it won't help you find a candidate
who ran for different offices over time; candidates get a new ID for each office.
'''
CANDIDATE_SEARCH = '''
Fetch basic information about candidates and their principal committees.
Each result reflects a unique FEC candidate ID. That ID is assigned to the candidate for a
particular office sought. If a candidate runs for the same office over time, that ID
stays the same. If the same person runs for multiple offices — for example, a House
candidate runs for a Senate office — that candidate will get a unique ID for each office.
The candidate endpoints primarily use data from FEC registration
[Form 1](http://www.fec.gov/pdf/forms/fecfrm1.pdf), for candidate information, and
[Form 2](http://www.fec.gov/pdf/forms/fecfrm2.pdf), for committees information, with additional information
to provide context.
'''
CANDIDATE_DETAIL = '''
This endpoint is useful for finding detailed information about a particular candidate. Use the
`candidate_id` to find the most recent information about that candidate.
'''
COMMITTEE_TAG = '''
Committees are entities that spend and raise money in an election. Their characteristics and
relationships with candidates can change over time.
You might want to use filters or search endpoints to find the committee you're looking
for. Then you can use other committee endpoints to explore information about the committee
that interests you.
Financial information is organized by `committee_id`, so finding the committee you're interested in
will lead you to more granular financial information.
The committee endpoints include all FEC filers, even if they aren't registered as a committee.
Officially, committees include the committees and organizations that file with the FEC.
Several different types of organizations file financial reports with the FEC:
* Campaign committees authorized by particular candidates to raise and spend funds in
their campaigns
* Non-party committees (e.g., PACs), some of which may be sponsored by corporations,
unions, trade or membership groups, etc.
* Political party committees at the national, state, and local levels
* Groups and individuals making only independent expenditures
* Corporations, unions, and other organizations making internal communications
The committee endpoints primarily use data from FEC registration Form 1 and Form 2.
'''
COMMITTEE_LIST = '''
Fetch basic information about committees and filers. Use parameters to filter for
particular characteristics.
'''
COMMITTEE_DETAIL = '''
This endpoint is useful for finding detailed information about a particular committee or
filer. Use the `committee_id` to find the most recent information about the committee.
'''
COMMITTEE_HISTORY = '''
Explore a filer's characteristics over time. This can be particularly useful if the
committees change treasurers, designation, or `committee_type`.
'''
ELECTION_SEARCH = '''
List elections by cycle, office, state, and district.
'''
ELECTIONS = '''
Look at the top-level financial information for all candidates running for the same
office.
Choose a 2-year cycle, and `house`, `senate` or `presidential`.
If you are looking for a Senate seat, you will need to select the state using a two-letter
abbreviation.
House races require state and a two-digit district number.
Since this endpoint reflects financial information, it will only have candidates once they file
financial reporting forms. Query the `/candidates` endpoint to see an up to date list of all the
candidates that filed to run for a particular seat.
'''
FINANCIAL_TAG = '''
Fetch key information about a committee's Form 3, Form 3X, or Form 3P financial reports.
Most committees are required to summarize their financial activity in each filing; those summaries
are included in these files. Generally, committees file reports on a quarterly or monthly basis, but
some must also submit a report 12 days before primary elections. Therefore, during the primary
season, the period covered by this file may be different for different committees. These totals
also incorporate any changes made by committees, if any report covering the period is amended.
Information is made available on the API as soon as it's processed. Keep in mind, complex
paper filings take longer to process.
The financial endpoints use data from FEC [form 5](http://www.fec.gov/pdf/forms/fecfrm5.pdf),
for independent expenditors; or the summary and detailed summary pages of the FEC
[Form 3](http://www.fec.gov/pdf/forms/fecfrm3.pdf), for House and Senate committees;
[Form 3X](http://www.fec.gov/pdf/forms/fecfrm3x.pdf), for PACs and parties;
and [Form 3P](http://www.fec.gov/pdf/forms/fecfrm3p.pdf), for presidential committees.
'''
WIP_TAG = '''
DISCLAIMER: The field labels contained within this resource are subject to change. We are attempting to succinctly
label these fields while conveying clear meaning to ensure accessibility for all users.
'''
REPORTS = '''
Each report represents the summary information from FEC Form 3, Form 3X and Form 3P.
These reports have key statistics that illuminate the financial status of a given committee.
Things like cash on hand, debts owed by committee, total receipts, and total disbursements
are especially helpful for understanding a committee's financial dealings.
By default, this endpoint includes both amended and final versions of each report. To restrict
to only the final versions of each report, use `is_amended=false`; to view only reports that
have been amended, use `is_amended=true`.
Several different reporting structures exist, depending on the type of organization that
submits financial information. To see an example of these reporting requirements,
look at the summary and detailed summary pages of FEC Form 3, Form 3X, and Form 3P.
'''
REPORTS += WIP_TAG
REPORT_YEAR = '''
Year that the record applies to. Sometimes records are amended in subsequent
years so this can differ from underlying form's receipt date.
'''
TWO_YEAR_TRANSACTION_PERIOD = '''
This is a two-year period that is derived from the year a transaction took place in the
Itemized Schedule A and Schedule B tables. In cases where we have the date of the transaction
(contribution_receipt_date in schedules/schedule_a, disbursement_date in schedules/schedule_b)
the two_year_transaction_period is named after the ending, even-numbered year. If we do not
have the date of the transaction, we fall back to using the report year (report_year in both
tables) instead, making the same cycle adjustment as necessary. If no transaction year is
specified, the results default to the most current cycle.
'''
TOTALS = '''
This endpoint provides information about a committee's Form 3, Form 3X, or Form 3P financial reports,
which are aggregated by two-year period. We refer to two-year periods as a `cycle`.
The cycle is named after the even-numbered year and includes the year before it. To see
totals from 2013 and 2014, you would use 2014. In odd-numbered years, the current cycle
is the next year — for example, in 2015, the current cycle is 2016.
For presidential and Senate candidates, multiple two-year cycles exist between elections.
'''
SCHEDULE_A_TAG = '''
Schedule A records describe itemized receipts reported by a committee. This is where
you can look for individual contributors. If you are interested in
individual donors, `/schedules/schedule_a` will be the endpoint you use.
Once a person gives more than a total of $200, the donations of that person must be
reported by committees that file F3, F3X and F3P forms.
Contributions $200 and under are not required to be itemized, but you can find the total
amount of these small donations by looking up the "unitemized" field in the `/reports`
or `/totals` endpoints.
When comparing the totals from reports to line items. the totals will not match unless you
only look at items where `"is_individual":true` since the same transaction is in the data
multiple ways to explain the way it may move though different committees as an earmark.
For the Schedule A aggregates, such as by_occupation and by_state, include only unique individual
contributions. See below for full methodology.
### Methodology for determining unique, individual contributions
For receipts over $200 use FEC code line_number to identify individuals.
The line numbers that specify individuals that are automatically included:
Line number with description
- 10 Contribution to Independent Expenditure-Only Committees (Super PACs),\n\
Political Committees with non-contribution accounts (Hybrid PACs)\n\
and nonfederal party "soft money" accounts (1991-2002)\n\
from a person (individual, partnership, limited liability company,\n\
corporation, labor organization, or any other organization or\n\
group of persons)
- 15 Contribution to political committees (other than Super PACs\n\
and Hybrid PACs) from an individual, partnership or\n\
limited liability company
- 15E Earmarked contributions to political committees\n\
(other than Super PACs and Hybrid PACs) from an individual,\n\
partnership or limited liability company
- 15J Memo - Recipient committee's percentage of contribution\n\
from an individual, partnership or limited liability\n\
company given to joint fundraising committee
- 18J | Memo - Recipient committee's percentage of contribution\n\
from a registered committee given to joint fundraising committee\n\
- 30, 30T, 31, 31T, 32 Individual party codes\n\
For receipts under $200:
We check the following codes and see if there is "earmark" (or a variation) in the `memo_text`
description of the contribution.
Line number with description
-11AI The itemized individual contributions from F3 schedule A\n\
-12 Nonfederal other receipt - Levin Account (Line 2)\n\
-17 Itemized individual contributions from Form 3P\n\
-17A Itemized individual contributions from Form 3P\n\
-18 Itemized individual contributions from Form 3P\n\
Of those transactions,[under $200, and having "earmark" in the memo text OR transactions having the codes 11A, 12, 17, 17A, or 18], we then want to exclude earmarks.
This is [the sql function](https://github.com/fecgov/openFEC/blob/develop/data/functions/individual.sql) that defines individual contributions:
'''
SCHEDULE_A = SCHEDULE_A_TAG + '''
The data is divided in two-year periods, called `two_year_transaction_period`, which
is derived from the `contribution_receipt_date`. If no value is supplied, the results
will default to the most recent two-year period that is named after the ending,
even-numbered year.
Due to the large quantity of Schedule A filings, this endpoint is not paginated by
page number. Instead, you can request the next page of results by adding the values in
the `last_indexes` object from `pagination` to the URL of your last request. For
example, when sorting by `contribution_receipt_date`, you might receive a page of
results with the following pagination information:
```
pagination: {\n\
pages: 2152643,\n\
per_page: 20,\n\
count: 43052850,\n\
last_indexes: {\n\
last_index: "230880619",\n\
last_contribution_receipt_date: "2014-01-01"\n\
}\n\
}\n\
```
To fetch the next page of sorted results, append `last_index=230880619` and
`last_contribution_receipt_date=2014-01-01` to the URL. We strongly advise paging through
these results by using sort indices (defaults to sort by contribution date), otherwise some resources may be
unintentionally filtered out. This resource uses keyset pagination to improve query performance and these indices
are required to properly page through this large dataset.
Note: because the Schedule A data includes many records, counts for
large result sets are approximate; you will want to page through the records until no records are returned.
'''
SUB_ID = '''
A unique database identifier for itemized receipts or disbursements.
'''
SCHEDULE_B_TAG = '''
Schedule B filings describe itemized disbursements. This data
explains how committees and other filers spend their money. These figures are
reported as part of forms F3, F3X and F3P.
'''
SCHEDULE_B = SCHEDULE_B_TAG + '''
The data is divided in two-year periods, called `two_year_transaction_period`, which
is derived from the `disbursement_date`. If no value is supplied, the results will
default to the most recent two-year period that is named after the ending,
even-numbered year.
Due to the large quantity of Schedule B filings, this endpoint is not paginated by
page number. Instead, you can request the next page of results by adding the values in
the `last_indexes` object from `pagination` to the URL of your last request. For
example, when sorting by `disbursement_date`, you might receive a page of
results with the following pagination information:
```
pagination: {\n\
pages: 965191,\n\
per_page: 20,\n\
count: 19303814,\n\
last_indexes: {\n\
last_index: "230906248",\n\
last_disbursement_date: "2014-07-04"\n\
}\n\
}\n\
```
To fetch the next page of sorted results, append `last_index=230906248` and
`last_disbursement_date=2014-07-04` to the URL. We strongly advise paging through
these results by using the sort indices (defaults to sort by disbursement date, e.g. `last_disbursement_date`), otherwise
some resources may be unintentionally filtered out. This resource uses keyset pagination to improve query performance
and these indices are required to properly page through this large dataset.
Note: because the Schedule B data includes many records, counts for
large result sets are approximate; you will want to page through the records until no records are returned.
'''
SCHEDULE_B_BY_PURPOSE = '''
Schedule B receipts aggregated by disbursement purpose category. To avoid double counting, memoed items are not included.
Purpose is a combination of transaction codes, category codes and disbursement description. See [the sql function](https://github.com/fecgov/openFEC/blob/7d2c058706f1b385b2cc18d75eb3ad0a1fba9d52/data/functions/purpose.sql)
'''
SCHEDULE_C_TAG = '''
Schedule C shows all loans, endorsements and loan guarantees a committee
receives or makes.
'''
SCHEDULE_C = SCHEDULE_C_TAG + '''
The committee continues to report the loan until it is repaid.
'''
SCHEDULE_D_TAG = '''
Schedule D shows debts and obligations owed to or by the committee that are
required to be disclosed.
'''
SCHEDULE_D = SCHEDULE_D_TAG + '''
'''
SCHEDULE_E_TAG = '''
Schedule E covers the line item expenditures for independent expenditures. For example, if a super PAC
bought ads on TV to oppose a federal candidate, each ad purchase would be recorded here with
the expenditure amount, name and id of the candidate, and whether the ad supported or opposed the candidate.
An independent expenditure is an expenditure for a communication "expressly advocating the election or
defeat of a clearly identified candidate that is not made in cooperation, consultation, or concert with,
or at the request or suggestion of, a candidate, a candidate’s authorized committee, or their agents, or
a political party or its agents."
Aggregates by candidate do not include 24 and 48 hour reports. This ensures we don't double count expenditures
and the totals are more accurate. You can still find the information from 24 and 48 hour reports in
`/schedule/schedule_e/`.
'''
SCHEDULE_E = SCHEDULE_E_TAG + '''
Due to the large quantity of Schedule E filings, this endpoint is not paginated by
page number. Instead, you can request the next page of results by adding the values in
the `last_indexes` object from `pagination` to the URL of your last request. For
example, when sorting by `expenditure_amount`, you might receive a page of
results with the following pagination information:
```
"pagination": {\n\
"count": 152623,\n\
"last_indexes": {\n\
"last_index": "3023037",\n\
"last_expenditure_amount": -17348.5\n\
},\n\
"per_page": 20,\n\
"pages": 7632\n\
}\n\
}\n\
```
To fetch the next page of sorted results, append `last_index=3023037` and
`last_expenditure_amount=` to the URL. We strongly advise paging through
these results by using the sort indices (defaults to sort by disbursement date, e.g. `last_disbursement_date`), otherwise
some resources may be unintentionally filtered out. This resource uses keyset pagination to improve query performance
and these indices are required to properly page through this large dataset.
Note: because the Schedule E data includes many records, counts for
large result sets are approximate; you will want to page through the records until no records are returned.
'''
SCHEDULE_F_TAG = '''
Schedule F shows all special expenditures a national or state party committee makes in connection with
the general election campaigns of federal candidates
'''
SCHEDULE_F = SCHEDULE_F_TAG + '''
These coordinated party expenditures do not count against the contribution limits but are subject to other limits,
these limits are detailed in Chapter 7 of the FEC Campaign Guide for Political Party Committees.
'''
SIZE_DESCRIPTION = '''
This endpoint aggregates Schedule A donations based on size:
- $200 and under\n\
- $200.01 - $499.99\n\
- $500 - $999.99\n\
- $1000 - $1999.99\n\
- $2000 +\n\
In cases where the donations are $200 or less, the results include small donations
that are reported on Schedule A, but filers are not required to itemize those small
donations, so we also add unitemized contributions. Unitemized contributions come
from the summary section of the forms. It represents the total money brought in from
donors that are not reported on Schedule A and have given $200 or less.
'''
SIZE = '''
The total all contributions in the following ranges:
```
-0 $200 and under\n\
-200 $200.01 - $499.99\n\
-500 $500 - $999.99\n\
-1000 $1000 - $1999.99\n\
-2000 $2000 +\n\
```
Unitemized contributions are included in the `0` category.
'''
STATE_AGGREGATE = '''
Schedule A individual receipts aggregated by contributor state.
This is an aggregate of only individual contributions. To avoid double counting,
memoed items are not included. Transactions $200 and under do not have to be
itemized, if those contributions are not itemized, they will not be included in the
state totals.
'''
STATE_AGGREGATE_RECIPIENT_TOTALS = STATE_AGGREGATE + '''
These receipts are then added together by committee type for the total amount
of each type, grouped by state and cycle.
'''
API_KEY_DESCRIPTION = '''
API key for https://api.data.gov. Get one at https://api.data.gov/signup.
'''
SEARCH_TAG = '''
Search for candidates or committees by name.
'''
FILINGS_TAG = '''
Search for financial reports and other FEC documents.
'''
FILINGS = '''
All official records and reports filed by or delivered to the FEC.
Note: because the filings data includes many records, counts for large
result sets are approximate; you will want to page through the records until no records are returned.
'''
DOC_TYPE = '''
The type of document,\n\
for documents other\n\
than reports:\n\
- 2 24 Hour\n\
Contribution Notice\n\
- 4 48 Hour\n\
Contribution Notice\n\
- A Debt Settlement\n\
Statement\n\
- B Acknowledgment of\n\
Receipt of Debt\n\
Settlement\n\
Statement\n\
- C RFAI: Debt\n\
Settlement\n\
First Notice\n\
- D Commission Debt\n\
Settlement Review\n\
- E Commission Response\n\
TO Debt\n\
Settlement Request\n\
- F Administrative\n\
Termination\n\
- G Debt Settlement\n\
Plan Amendment\n\
- H Disavowal Notice\n\
- I Disavowal Response\n\
- J Conduit Report\n\
- K Termination\n\
Approval\n\
- L Repeat Non-Filer\n\
Notice\n\
- M Filing Frequency\n\
Change Notice\n\
- N Paper Amendment to\n\
Electronic Report\n\
- O Acknowledgment of\n\
Filing Frequency\n\
Change\n\
- S RFAI: Debt\n\
Settlement Second\n\
- T Miscellaneous\n\
Report TO FEC\n\
- V Repeat Violation\n\
Notice\n\
(441A OR 441B)\n\
- P Notice of\n\
Paper Filing\n\
- R F3L Filing\n\
Frequency\n\
Change Notice\n\
- Q Acknowledgment of\n\
F3L Filing \n\
Frequency Change\n\
- U Unregistered\n\
Committee Notice\n\
'''
DATES_TAG = '''
Reporting deadlines, election dates FEC meetings, events etc.
'''
CALENDAR_DATES = '''
Combines the election and reporting dates with Commission meetings, conferences, outreach, Advisory Opinions, rules, litigation dates and other
events into one calendar.
State and report type filtering is no longer available.
'''
CALENDAR_EXPORT = '''
Returns CSV or ICS for downloading directly into calendar applications like Google, Outlook or other applications.
Combines the election and reporting dates with Commission meetings, conferences, outreach, Advisory Opinions, rules, litigation dates and other
events into one calendar.
State filtering now applies to elections, reports and reporting periods.
Presidential pre-primary report due dates are not shown on even years.
Filers generally opt to file monthly rather than submit over 50 pre-primary election
reports. All reporting deadlines are available at /reporting-dates/ for reference.
This is [the sql function](https://github.com/fecgov/openFEC/blob/develop/data/migrations/V40__omnibus_dates.sql)
that creates the calendar.
'''
COMMUNICATION_TAG = '''
Reports of communication costs by corporations and membership organizations
from the FEC [F7 forms](http://www.fec.gov/pdf/forms/fecform7.pdf).
'''
ELECTIONEERING = '''
An electioneering communication is any broadcast, cable or satellite communication that fulfills each of the following conditions:
- The communication refers to a clearly identified federal candidate;\n\
- The communication is publicly distributed by a television station,\n\
radio station, cable television system or satellite system for a fee; and\n\
- The communication is distributed within 60 days prior\n\
to a general election or 30 days prior to a primary election to federal office.\n\
'''
COMMUNICATION_COST = '''
52 U.S.C. 30118 allows "communications by a corporation to its stockholders and
executive or administrative personnel and their families or by a labor organization
to its members and their families on any subject," including the express advocacy of
the election or defeat of any Federal candidate. The costs of such communications
must be reported to the Federal Election Commission under certain circumstances.
'''
FILER_RESOURCES = '''
Useful tools for those who file with the FEC.
Look up RAD analyst with telephone extension by committee_id.
'''
RAD_ANALYST = '''
Use this endpoint to look up the RAD Analyst for a committee.
The mission of the Reports Analysis Division (RAD) is to ensure that
campaigns and political committees file timely and accurate reports that fully disclose
their financial activities. RAD is responsible for reviewing statements and financial
reports filed by political committees participating in federal elections, providing
assistance and guidance to the committees to properly file their reports, and for taking
appropriate action to ensure compliance with the Federal Election Campaign Act (FECA).
'''
# fields and filters
# shared
LOAD_DATE = 'Date the information was loaded into the FEC systems. This can be affected by \
reseting systems and other factors, refer to receipt_date for the day that the FEC received \
the paper or electronic document. Keep in mind that paper filings take more time to process \
and there can be a lag between load_date and receipt_date. This field can be helpful to \
identify paper records that have been processed recently.'
PARTY = 'Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.'
PARTY_FULL = 'Party affiliated with a candidate or committee'
FORM_TYPE = 'The form where the underlying data comes from, for example, Form 1 would appear as F1:\n\
- F1 Statement of\n\
Organization\n\
- F1M Notification of\n\
Multicandidate\n\
Status\n\
- F2 Statement of Candidacy\n\
- F3 Report of Receipts and\n\
Disbursements for an \n\
Authorized Committee\n\
- F3P Report of Receipts and\n\
Disbursements by an\n\
Authorized Committee\n\
of a Candidate for\n\
The Office of President\n\
or Vice President\n\
- F3L Report of Contributions\n\
Bundled by Lobbyists/\n\
Registrants and Lobbyist/\n\
Registrant PACs\n\
- F3X Report of Receipts and\n\
Disbursements for other \n\
than an Authorized \n\
Committee\n\
- F4 Report of Receipts and \n\
Disbursements for a \n\
Committee or Organization\n\
Supporting a Nomination\n\
Convention\n\
- F5 Report of Independent \n\
Expenditures Made and \n\
Contributions Received\n\
- F6 48 Hour Notice of \n\
Contributions/Loans\n\
Received\n\
- F7 Report of Communication\n\
Costs by Corporations \n\
and Membership \n\
Organizations\n\
- F8 Debt Settlement Plan\n\
- F9 24 Hour Notice of \n\
Disbursements for \n\
Electioneering \n\
Communications\n\
- F13 Report of Donations \n\
Accepted for Inaugural\n\
Committee\n\
- F99 Miscellaneous Text\n\
- FRQ Request for Additional\n\
Information\n\
'
REPORT_TYPE = 'Name of report where the underlying data comes from:\n\
- 10D Pre-Election\n\
- 10G Pre-General\n\
- 10P Pre-Primary\n\
- 10R Pre-Run-Off\n\
- 10S Pre-Special\n\
- 12C Pre-Convention\n\
- 12G Pre-General\n\
- 12P Pre-Primary\n\
- 12R Pre-Run-Off\n\
- 12S Pre-Special\n\
- 30D Post-Election\n\
- 30G Post-General\n\
- 30P Post-Primary\n\
- 30R Post-Run-Off\n\
- 30S Post-Special\n\
- 60D Post-Convention\n\
- M1 January Monthly\n\
- M10 October Monthly\n\
- M11 November Monthly\n\
- M12 December Monthly\n\
- M2 February Monthly\n\
- M3 March Monthly\n\
- M4 April Monthly\n\
- M5 May Monthly\n\
- M6 June Monthly\n\
- M7 July Monthly\n\
- M8 August Monthly\n\
- M9 September Monthly\n\
- MY Mid-Year Report\n\
- Q1 April Quarterly\n\
- Q2 July Quarterly\n\
- Q3 October Quarterly\n\
- TER Termination Report\n\
- YE Year-End\n\
- 90S Post Inaugural\n\
Supplement\n\
- 90D Post Inaugural\n\
- 48 48 Hour Notification\n\
- 24 24 Hour Notification\n\
- M7S July Monthly/\n\
Semi-Annual\n\
- MSA Monthly Semi-Annual\n\
(MY)\n\
- MYS Monthly Year End/\n\
Semi-Annual\n\
- Q2S July Quarterly/\n\
Semi-Annual\n\
- QSA Quarterly Semi-Annual\n\
(MY)\n\
- QYS Quarterly Year End/\n\
Semi-Annual\n\
- QYE Quarterly Semi-Annual\n\
(YE)\n\
- QMS Quarterly Mid-Year/\n\
Semi-Annual\n\
- MSY Monthly Semi-Annual\n\
(YE)\n\
'
REQUEST_TYPE = 'Requests for additional information (RFAIs)\n\
sent to filers.\n\
The request type is based on\n\
the type of document filed:\n\
- 1 Statement of \n\
Organization\n\
- 2 Report of Receipts\n\
and Expenditures\n\
(Form 3 and 3X)\n\
- 3 Second Notice - Reports\n\
- 4 Request for\n\
Additional Information\n\
- 5 Informational - Reports\n\
- 6 Second Notice -\n\
Statement of Organization\n\
- 7 Failure to File\n\
- 8 From Public Disclosure\n\
- 9 From Multi\n\
Candidate Status\n\
'
REPORT_TYPE_W_EXCLUDE = 'Report type; prefix with "-" to exclude. '+REPORT_TYPE
RECEIPT_DATE = 'Date the FEC received the electronic or paper record'
STATE_GENERIC = 'US state or territory'
ZIP_CODE = 'Zip code'
#candidates
CANDIDATE_NAME = 'Name of candidate running for office'
OFFICE_FULL = 'Federal office candidate runs for: House, Senate or presidential'
OFFICE = 'Federal office candidate runs for: H, S or P'
STATE = 'US state or territory where a candidate runs for office'
YEAR = 'See records pertaining to a particular election year. The list of election years \
is based on a candidate filing a statement of candidacy (F2) for that year.'
DISTRICT = 'Two-digit US House distirict of the office the candidate is running for. \
Presidential, Senate and House at-large candidates will have District 00.'
CANDIDATE_STATUS = 'One-letter code explaining if the candidate is:\n\
- C present candidate\n\
- F future candidate\n\
- N not yet a candidate\n\
- P prior candidate\n\
'
LAST_F2_DATE = 'The day the FEC received the candidate\'s most recent Form 2'
FIRST_CANDIDATE_FILE_DATE = 'The day the FEC received the candidate\'s first filing. \
This is a F2 candidate registration.'
LAST_CANDIDATE_FILE_DATE = 'The day the FEC received the candidate\'s most recent filing'
INCUMBENT_CHALLENGE = "One-letter code ('I', 'C', 'O') explaining if the candidate is an incumbent, a challenger, or if the seat is open."
INCUMBENT_CHALLENGE_FULL = 'Explains if the candidate is an incumbent, a challenger, or if the seat is open.'
ACTIVE_THROUGH = 'Last year a candidate was active. This field is specific to the candidate_id so if the same person runs for another office, there may be a different record for them.'
HAS_RAISED_FUNDS = 'A boolean that describes if a candidate\'s committee has ever received any receipts for their campaign for this particular office. (Candidates have separate candidate IDs for each office.)'
FEDERAL_FUNDS_FLAG = 'A boolean the describes if a presidential candidate has accepted federal funds. The flag will be false for House and Senate candidates.'
# committees
COMMITTEE_NAME = 'The name of the committee. If a committee changes its name, \
the most recent name will be shown. Committee names are not unique. Use committee_id \
for looking up records.'
COMMITTEE_YEAR = 'A year that the committee was active— (after original registration date \
or filing but before expiration date)'
DESIGNATION = 'The one-letter designation\n\
code of the organization:\n\
- A authorized by\n\
a candidate\n\
- J joint fundraising\n\
committee\n\
- P principal campaign\n\
committee of a\n\
candidate\n\
- U unauthorized\n\
- B lobbyist/registrant\n\
PAC\n\
- D leadership PAC\n\
'
ORGANIZATION_TYPE = 'The one-letter\n\
code for the kind\n\
for organization:\n\
- C corporation\n\
- L labor\n\
organization\n\
- M membership\n\
organization\n\
- T trade association\n\
- V cooperative\n\
- W corporation without\n\
capital stock\n\
'
COMMITTEE_TYPE = 'The one-letter type\n\
code of the\n\
organization:\n\
- C communication\n\
cost\n\
- D delegate\n\
- E electioneering\n\
communication\n\
- H House\n\
- I independent\n\
expenditor\n\
(person or group)\n\
- N PAC -\n\
nonqualified\n\
- O independent\n\
expenditure-only\n\
(super PACs)\n\
- P presidential\n\
- Q PAC - qualified\n\
- S Senate\n\
- U single candidate\n\
independent\n\
expenditure\n\
- V PAC with\n\
non-contribution\n\
account,\n\
nonqualified\n\
- W PAC with\n\
non-contribution\n\
account,\n\
qualified\n\
- X party,\n\
nonqualified\n\
- Y party, qualified\n\
- Z national party\n\
non-federal\n\
account\n\
'
COMMITTEE_TYPE_STATE_AGGREGATE_TOTALS = COMMITTEE_TYPE + '\
- all All Committee Types\n\
- all_candidates\n\
All Candidate Committee\n\
Types (H, S, P)\n\
- all_pacs All PAC\n\
Committee Types\n\
(N, O, Q, V, W)\n\
'
PAC_PARTY_TYPE = 'The one-letter type\n\
code of a PAC/Party\n\
organization:\n\
- N PAC - nonqualified\n\
- O independent\n\
expenditure-only\n\
(super PACs)\n\
- Q PAC - qualified\n\
- V PAC with\n\
non-contribution\n\
account,\n\
nonqualified\n\
account,\n\
qualified\n\
- X party,\n\
nonqualified\n\
- Y party,\n\
qualified\n\
'
TREASURER_NAME = 'Name of the Committee\'s treasurer. If multiple treasurers for the \
committee, the most recent treasurer will be shown.'
COMMITTEE_STATE = 'State of the committee\'s address as filed on the Form 1'
FIRST_FILE_DATE = 'The day the FEC received the committee\'s first filing. \
This is usually a Form 1 committee registration.'
LAST_FILE_DATE = 'The day the FEC received the committee\'s most recent filing'
LAST_F1_DATE = 'The day the FEC received the committee\'s most recent Form 1'
MEANS_FILED = 'The method used to file with the FEC, either electronic or on paper.'
# schedules
MEMO_CODE = "'X' indicates that the amount is NOT to be included in the itemization total."
# schedule A
CONTRIBUTOR_ID = 'The FEC identifier should be represented here if the contributor is registered with the FEC.'
EMPLOYER = 'Employer of contributor as reported on the committee\'s filing'
OCCUPATION = 'Occupation of contributor as reported on the committee\'s filing'
CONTRIBUTOR_NAME = 'Name of contributor'
CONTRIBUTOR_CITY = 'City of contributor'
CONTRIBUTOR_STATE = 'State of contributor'
CONTRIBUTOR_EMPLOYER = 'Employer of contributor, filers need to make an effort to gather this information'
CONTRIBUTOR_OCCUPATION = 'Occupation of contributor, filers need to make an effort to gather this information'
CONTRIBUTOR_ZIP = 'Zip code of contributor'
IS_INDIVIDUAL = 'Restrict to non-earmarked individual contributions where memo code is true. \
Filtering individuals is useful to make sure contributions are not double reported and in creating \
breakdowns of the amount of money coming from individuals.'
# schedule B
RECIPIENT_NAME = 'Name of the entity receiving the disbursement'
RECIPIENT_ID = 'The FEC identifier should be represented here if the entity receiving \
the disbursement is registered with the FEC.'
# communication cost and electioneering
SUPPORT_OPPOSE_INDICATOR = 'Explains if the money was spent in order to support or oppose a candidate or candidates. (Coded S or O for support or oppose.) This indicator applies to independent expenditures and communication costs.'
# schedule B
PURPOSE = 'Purpose of the expenditure'
# schedule E
EXPENDITURE_MAX_DATE = 'Selects all items expended by this committee before this date'
EXPENDITURE_MIN_DATE = 'Selects all items expended by this committee after this date'
EXPENDITURE_MIN_AMOUNT = 'Selects all items expended by this committee greater than this amount'
EXPENDITURE_MAX_AMOUNT = 'Selects all items expended by this committee less than this amount'
# dates
DUE_DATE = 'Date the report is due'
CREATE_DATE = 'Date the record was created'
UPDATE_DATE = 'Date the record was updated'
ELECTION_DATE = 'Date of election'
ELECTION_YEAR = 'Year of election'
#? TODO: add more categories
ELECTION_TYPE = 'Election type \n\
Convention, Primary,\n\
General, Special,\n\
Runoff etc.\n\
'
SENATE_CLASS = 'Senators run every six years and each state has two senators. General elections \
are held every 2 years. The Senate elections are staggered so there are three classes of Senators \
In a given state, only one Senate seat is up for election at a time and every six years, there is \
not a senate election in a given state. Thus, the Senate is broken up in to three groups called \
classes. Senators in the same class are up for election at the same time. Sometimes it is a bit \
less straight forward when, because there are situations in which there is a special election to \
fill a vacancy in the Senate. In those cases class refers to the seat groupings and not the time \
of the election.'
# filings
ENDING_IMAGE_NUMBER = 'Image number is an unique identifier for each page the electronic or paper \
report. The last image number corresponds to the image number for the last page of the document.'
IMAGE_NUMBER = 'An unique identifier for each page the electronic or paper \
report.'
# Reports and Totals
def add_period(var):
return var + ' total for the reporting period'
def add_ytd(var):
return var + ' total for the year to date'
# shared
CASH_ON_HAND_BEGIN_PERIOD = 'Balance for the committee at the start of the two-year period'
CASH_ON_HAND_END_PERIOD = 'Ending cash balance on the most recent filing'
COVERAGE_START_DATE = 'Beginning date of the reporting period'
COVERAGE_END_DATE = 'Ending date of the reporting period'
DEBTS_OWED_BY_COMMITTEE = 'Debts owed by the committee'
DEBTS_OWED_TO_COMMITTEE = 'Debts owed to the committee'
# shared receipts
RECEIPTS = 'Anything of value (money, goods, services or property) received by a political committee'
# can't tack on period or year without being really confusing
INDIVIDUAL_ITEMIZED_CONTRIBUTIONS = 'Individual itemized contributions are from individuals whose aggregate contributions total over $200 per individual per year. Be aware, some filers choose to itemize donations $200 or less.'
INDIVIDUAL_ITEMIZED_CONTRIBUTIONS_PERIOD = 'Individual itemized contributions are from individuals whose aggregate contributions total over $200 per individual per year. This amount represents the total of these receipts for the reporting period.'
INDIVIDUAL_ITEMIZED_CONTRIBUTIONS_YTD = 'Individual itemized contributions are from individuals whose aggregate contributions total over $200 per individual per year. This amount represents the total of these receipts for the year to date.'
INDIVIDUAL_UNITEMIZED_CONTRIBUTIONS = 'Unitemized contributions are made individuals whose aggregate contributions total $200 or less per individual per year. Be aware, some filers choose to itemize donations $200 or less and in that case those donations will appear in the itemized total.'
INDIVIDUAL_UNITEMIZED_CONTRIBUTIONS_PERIOD = 'Unitemized contributions are from individuals whose aggregate contributions total $200 or less per individual per year. This amount represents the total of these receipts for the reporting period.'
INDIVIDUAL_UNITEMIZED_CONTRIBUTIONS_YTD = 'Itemized contributions are from individuals whose aggregate contributions total $200 or less per individual per year. This amount represents the total of these receipts for the year to date.'
POLITICAL_PARTY_COMMITTEE_CONTRIBUTIONS = 'Party committees contributions'
INDIVIDUAL_CONTRIBUTIONS = 'Individual contributions'
OTHER_POLITICAL_COMMITTEE_CONTRIBUTIONS = 'Other committees contributions'
OFFSETS_TO_OPERATING_EXPENDITURES = 'Offsets to operating expenditures'
CONTRIBUTIONS = 'Contribution'
# house senate and presidential
CANDIDATE_CONTRIBUTION = 'Candidate contributions'
OTHER_RECEIPTS = 'Other receipts'
# house senate and PAC party
NET_CONTRIBUTIONS = 'Net contributions'
# shared disbursements
DISBURSEMENTS = 'Disbursements'
REFUNDED_INDIVIDUAL_CONTRIBUTIONS = 'Individual refunds'
OPERATING_EXPENDITURES = 'Total operating expenditures'
OTHER_DISBURSEMENTS = 'Other disbursements'
REFUNDED_POLITICAL_PARTY_COMMITTEE_CONTRIBUTIONS = 'Political party refunds'
CONTRIBUTION_REFUNDS = 'Total contribution refunds'
REFUNDED_OTHER_POLITICAL_COMMITTEE_CONTRIBUTIONS = 'Other committee refunds'
#loans
LOAN_SOURCE = "Source of the loan (i.e., bank loan, brokerage account, credit card, home equity line of credit," \
"other line of credit, or personal funds of the candidate"
# presidential
# receipts
FEDERAL_FUNDS = 'Federal funds: Public funding of presidential elections means that qualified presidential candidates receive federal government funds to pay for the valid expenses of their political campaigns in both the primary and general elections.'
TRANSFERS_FROM_AFFILIATED_COMMITTEE = 'Transfers from affiliated committees'
LOANS_RECEIVED_FROM_CANDIDATE = 'Loans made by candidate'
OTHER_LOANS_RECEIVED = 'Other loans'
LOANS_RECEIVED = 'Total loans received'
OFFSETS_TO_FUNDRAISING_EXPENDITURES = 'Fundraising offsets'
OFFSETS_TO_LEGAL_ACCOUNTING = 'Legal and accounting offsets'
TOTAL_OFFSETS_TO_OPERATING_EXPENDITURES = 'Total offsets'
# disbursements
TRANSFERS_TO_OTHER_AUTHORIZED_COMMITTEE = 'Transfers to authorized committees'
REPAYMENTS_LOANS_MADE_BY_CANDIDATE = 'Candidate loan repayments'
REPAYMENTS_OTHER_LOANS = 'Other loan repayments'
LOAN_REPAYMENTS_MADE = 'Total loan repayments'
# House Senate
# receipts
TRANSFERS_FROM_OTHER_AUTHORIZED_COMMITTEE = 'Transfers from authorized committees'
LOANS_MADE_BY_CANDIDATE = 'Loans made by candidate'
ALL_OTHER_LOANS = 'Other loans'
LOANS = 'Total loans received'
# disbursements
NET_OPERATING_EXPENDITURES = 'Net operating expenditures'
TRANSFERS_TO_OTHER_AUTHORIZED_COMMITTEE = 'Transfers to authorized committees'
LOAN_REPAYMENTS_CANDIDATE_LOANS = 'Candidate loan repayments'
LOAN_REPAYMENTS_OTHER_LOANS = 'Other loan repayments'
OTHER_DISBURSEMENTS = 'Other disbursements'
# PAC and Party
# Receipts
TRANSFERS_FROM_AFFILIATED_PARTY = 'Transfers from affiliated committees'
ALL_LOANS_RECEIVED = 'Loans received'
LOAN_REPAYMENTS_RECEIVED = 'Loan repayments received'
FED_CANDIDATE_CONTRIBUTION_REFUNDS = 'Candidate refunds'
OTHER_FED_RECEIPTS = 'Other receipts'
TRANSFERS_FROM_NONFED_ACCOUNT = 'Non-federal transfers'
TRANSFERS_FROM_NONFED_LEVIN = 'Levin funds'
TRANSFERS_FROM_NONFED_ACCOUNT = 'Total non-federal transfers'
FED_RECEIPTS = 'Total federal receipts'
# disbursement
SHARED_FED_OPERATING_EXPENDITURES = 'Federal allocated operating expenditures'
SHARED_NONFED_OPERATING_EXPENDITURES = 'Non-federal operating expenditures'
OTHER_FED_OPERATING_EXPENDITURES = 'Other federal operating expenditures'
NET_OPERATING_EXPENDITURES = 'Net operating expenditures'
TRANSFERS_TO_AFFILIATED_COMMITTEE = 'Transfers to affiliated committees'
FED_CANDIDATE_COMMITTEE_CONTRIBUTIONS = 'Contributions to other federal committees'
INDEPENDENT_EXPENDITURES = 'Independent expenditures'
COORDINATED_EXPENDITURES_BY_PARTY_COMMITTEE = 'Coordinated party expenditures'
LOANS_MADE = 'Loans made'
LOAN_REPAYMENTS_MADE = 'Loan repayments made'
SHARED_FED_ACTIVITY = 'Allocated federal election activity - federal share'
ALLOCATED_FEDERAL_ELECTION_LEVIN_SHARE = 'Allocated federal election activity - Levin share'
NON_ALLOCATED_FED_ELECTION_ACTIVITY = 'Federal election activity - federal only'
FED_ELECTION_ACTIVITY = 'Total federal election activity'
FED_DISBURSEMENTS = 'Total federal disbursements'
# calendar
CATEGORY = '''
Each type of event has a calendar category with an integer id. Options are: Open Meetings: 32, Executive Sessions: 39, Public Hearings: 40,
Conferences: 33, Roundtables: 34, Election Dates: 36, Federal Holidays: 37, FEA Periods: 38, Commission Meetings: 20,
Reporting Deadlines: 21, Conferences and Outreach: 22, AOs and Rules: 23, Other: 24, Quarterly: 25, Monthly: 26,
Pre and Post-Elections: 27, EC Periods:28, and IE Periods: 29
'''
CAL_STATE = 'The state field only applies to election dates and reporting deadlines, reporting periods and all other dates do not have the array of states to filter on'
CAL_DESCRIPTION = 'Brief description of event'
SUMMARY = 'Longer description of event'
EVENT_ID = 'An unique ID for an event. Useful for downloading a single event to your calendar. This ID is not a permanent, persistent ID.'
# efiling
EFILING_TAG = '''
Efiling endpoints provide real-time campaign finance data for electronic filers.
These endpoints are perfect for watching filings roll in when you want to know the latest information. Efiling endpoints
only contain the most recent two years worth of data and don't contain the processed and coded data that
you can find on the other endpoints. Those endpoints are better for in-depth analysis.
Senate candidates and committees are required to file by paper. Other committees who raise and spend less than $50,000
in a calendar can choose whether to file electronically or by paper.
'''
EFILING_TAG += WIP_TAG
EFILE_FILES = 'Basic information about electronic files coming into the FEC, posted as they are received.'
FILE_NUMBER = 'Filing ID number'
AMENDMENT_CHAIN = '''
The first value in the chain is the original filing. The ordering in the chain reflects the order the
amendments were filed up to the amendment being viewed.
'''
AMENDMENT_INDICATOR = '''
-N new\n\
-A amendment\n\
-T terminated\n\
-C consolidated\n\
-M multi-candidate\n\
-S secondary\n\n\
Null might be\n\
new or amendment.\n\
If amendment\n\
indicator is null\n\
and the filings\n\
is the first\n\
or first in a\n\
chain treat it\n\
as if it was a new.\n\
If it is not the\n\
first or first\n\
in a chain then\n\
treat the filing\n\
as an amendment.\n\
'''
AMENDED_BY = '''
If this report has been amended, this field gives the file_number of the report that should be used. For example,
if a report is amended multiple times, the first report and the first amendment will have the file_number of the final amended
report in the ameded_by field and the final report will have no id in the amended_by field.
'''
AMENDS_FILE = '''
For amendments, this file_number is the file_number of the previous report that is being amended. See amended_by
for the most recent version of the report.
'''
AMENDMENT_NUMBER = '''
Number of times the report has been amended.
'''
EFILE_REPORTS = '''
Key financial data reported periodically by committees as they are reported. This feed includes summary
information from the the House F3 reports, the presidential F3p reports and the PAC and party
F3x reports.
Generally, committees file reports on a quarterly or monthly basis, but
some must also submit a report 12 days before primary elections. Therefore, during the primary
season, the period covered by this file may be different for different committees. These totals
also incorporate any changes made by committees, if any report covering the period is amended.
'''
EFILE_REPORTS += WIP_TAG
MIN_FILTER = 'Filter for all amounts greater than a value.'
MAX_FILTER = 'Filter for all amounts less than a value.'
ENTITY_RECEIPTS_TOTLAS = '''
Provides cumulative receipt totals by entity type, over a two year cycle. Totals are adjusted to avoid double counting.
This is [the sql](https://github.com/fecgov/openFEC/blob/develop/data/migrations/V41__large_aggregates.sql) that creates these calculations.
'''
ENTITY_DISBURSEMENTS_TOTLAS = '''
Provides cumulative disbursement totals by entity type, over a two year cycle. Totals are adjusted to avoid double counting.
This is [the sql](https://github.com/fecgov/openFEC/blob/develop/data/migrations/V41__large_aggregates.sql) that creates these calculations.
'''
# Audit api
AUDIT = '''
The agency’s monitoring process may detect potential violations through a review of a committee’s reports or through a
Commission audit. By law, all enforcement cases must remain confidential until they’re closed.
The Commission is required by law to audit Presidential campaigns that accept public funds. In addition, the Commission
audits a committee when it appears not to have met the threshold requirements for substantial compliance with the Federal
Election Campaign Act. The audit determines whether the committee complied with limitations, prohibitions and disclosure
requirements.
These endpoints contain Final Audit Reports approved by the Commission since inception.
'''
#endpoint: audit-case
AUDIT_CASE = '''
This endpoint contains Final Audit Reports approved by the Commission since inception.
The search can be based on information about the audited committee (Name, FEC ID Number, Type, \n\
Election Cycle) or the issues covered in the report.
'''
#endpoint: audit-primary-category
AUDIT_PRIMARY_CATEGORY = '''
This lists the options for the primary categories available in the /audit-search/ endpoint.
'''
#endpoint: audit-category
AUDIT_CATEGORY = '''
This lists the options for the categories and subcategories available in the /audit-search/ endpoint.
'''
AUDIT_ID = '''
The audit issue. Each subcategory has an unique ID
'''
AUDIT_CASE_ID = '''
Primary/foreign key for audit tables
'''
PRIMARY_CATEGORY_ID = '''
Audit category ID (table PK)
'''
PRIMARY_CATEGORY_NAME = 'Primary Audit Category\n\
- No Findings or\n\
Issues/Not a Committee\n\
- Net Outstanding Campaign\n\
/Convention Expenditures/\n\
Obligations\n\
- Payments/Disgorgements\n\
- Allocation Issues\n\
- Prohibited Contributions\n\
- Disclosure\n\
- Recordkeeping\n\
- Repayment to US Treasury\n\
- Other\n\
- Misstatement of \n\
Financial Activity\n\
- Excessive Contributions\n\
- Failure to File\n\
Reports/Schedules/Notices\n\
- Loans\n\
- Referred Findings Not Listed\n\
'
SUB_CATEGORY_ID = '''
The finding id of an audit. Finding are a category of broader issues. Each category has an unique ID.
'''
SUB_CATEGORY_NAME = '''
The audit issue. Each subcategory has an unique ID.
'''
AUDIT_TIER = '''
1 specifies a primary category and 2 specifies a subcategory
'''
COMMITTEE_DESCRIPTION = 'Type of committee:\n\
- H or S - Congressional\n\
- P - Presidential\n\
- X or Y or Z - Party\n\
- N or Q - PAC\n\
- I - Independent expenditure\n\
- O - Super PAC \n\
'
FAR_RELEASE_DATE = '''
Final audit report release date
'''
LINK_TO_REPORT = '''
URL for retrieving the PDF document
'''