# Elevate Bill Run API

### bill runs 

Provides read & write access to bill run entities.

#### Definitions
* Bill run - a process by which customers are invoiced for their usage, rental and adhoc charges


Version: 1.9

## Servers

```
https://rest.elevatebilling.com/v1
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Elevate Bill Run API](https://docs.elevatebilling.com/_bundle/openapi/prod/gen/billing-rest-bill-run.yaml)

## bill-runs

a process by which customers are invoiced for their usage, rental and adhoc charges

### Get a list of available bill runs

 - [GET /bill-runs](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/bill-runs/getbillruns.md)

### Get a specific bill run

 - [GET /bill-runs/{bill_run_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/bill-runs/getbillrun.md)

### Update a specific bill run

 - [PATCH /bill-runs/{bill_run_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/bill-runs/updatebillrun.md): Close, reopen, and move a bill run to the next step. To fully close the bill run please initially patch the billRunStatus to CLOSED and summaryStatus to REPORTING. To generate draft invoices of a CLOSED bill run, PATCH the summaryStatus to DRAFT_INVOICES. To generate full invoices of a CLOSED bill run, PATCH the summaryStatus to FULL_INVOICES. To distribute and finalise the bill run having generated invoices, PATCH the summaryStatus to DISTRIBUTION. Please refer to the examples

### Adjust the schedule of the bill run by specified number of periods

 - [POST /adjust-bill-run-schedule/{bill_run_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/bill-runs/adjustbillrunschedule.md)

## adhoc-bill-runs

### Get a list of available adhoc bill runs

 - [GET /adhoc-bill-runs](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/adhoc-bill-runs/getadhocbillruns.md)

### Get a specific adhoc bill run

 - [GET /adhoc-bill-runs/{adhoc_bill_run_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/adhoc-bill-runs/getadhocbillrun.md)

### Update a specific adhoc bill run

 - [PATCH /adhoc-bill-runs/{adhoc_bill_run_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-bill-run/adhoc-bill-runs/updateadhocbillrun.md): Close, reopen, and move an adhoc bill run to the next step. To fully close the adhoc bill run please initially patch the summaryStatus to REPORTING. To generate invoices of a CLOSED adhoc bill run, PATCH the summaryStatus to FULL_INVOICES. To distribute and finalise the adhoc bill run having generated invoices, PATCH the summaryStatus to DISTRIBUTION. You can monitor the progress of the bill run summary state by doing a GET and looking at the summaryStatusPercentage. Please refer to the examples