# Get a list of available bill runs

Endpoint: GET /bill-runs
Version: 1.9
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `billRunStatus` (string)
    Filter by bill run status
    Enum: "OPEN", "CLOSED", "FINALIZED"

  - `billingCycleId` (integer)
    Filter by billing cycle id
    Example: 1

  - `billingCycleGroupName` (string)
    Filter by billing cycle group name
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Bill run identifier
    Example: 1

  - `name` (string, required)
    Bill run name

  - `sortableName` (string)
    Sortable bill run name

  - `billingCycleId` (integer, required)
    Billing cycle Id
    Example: 1

  - `created` (string)
    Creation date

  - `periodStartDate` (string, required)
    Bill run start date

  - `periodEndDate` (string, required)
    Bill run end date

  - `invoiceDate` (string, required)
    The billing agent may wish a date that is different to appear on the invoice to manage customer perception.

  - `includeUsageUntilDate` (string)
    All the usage charges up to this date will be included as part of the bill run

  - `billRunStatus` (string)
    Bill run status
    Enum: "OPEN", "CLOSED", "FINALIZED"

  - `summaryStatus` (string)
    Bill run summary status
    Enum: "PROPERTIES", "STARTING", "REPORTING", "DRAFT_INVOICES", "FULL_INVOICES", "DISTRIBUTION", "COMBINING_INVOICES", "PAYMENT", "REACTIVATING_RPIS", "ARCHIVING", "FINISHED"

  - `billingUserAdminId` (integer)
    Bill user who closed bill run
    Example: 1

  - `parallel` (boolean, required)
    Parallel bill run

  - `revenueInMajorCurrency` (integer, required)
    Revenue in this bill run now
    Example: 1

  - `usageSuspenseCount` (integer, required)
    Count of usage suspense records for this bill run now
    Example: 1

  - `rentalSuspenseCount` (integer, required)
    Count of rental suspense records for this bill run now
    Example: 1

  - `maxInvoiceValue` (number)
    Highest value invoice in the bill run

  - `maxInvoiceCustomerId` (integer)
    Customer Id
    Example: 1

  - `paused` (boolean)
    Bill runs associated to cycles that are set to auto-close may be paused. A paused bill run will not be automatically closed/finalised by the system


## Response 400 fields

## Response 401 fields

## Response 403 fields