Skip to contents

Schedule B disbursements 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. Inspect the disbursement_purpose sql function within the migrations for more details.

Usage

fec_get_schedules_schedule_b_by_purpose(
  purpose,
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

purpose

Disbursement purpose category

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

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.

sort_hide_null

Hide null values on sorted column(s).

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.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

per_page

The number of results returned per page. Defaults to 20.

sort

Provide a field to sort by. Use - for descending order.

api_key

An API key provided by the API provider. This key is not clearly documented in the API description. Check the API documentation for details.

Value

BKTODO: Return descriptions are not yet implemented in beekeeper