Get a list of available bill runs

get/bill-runs
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
billRunStatus
string (BillRunStatus)

Filter by bill run status

Enum: "OPEN" "CLOSED" "FINALIZED"
billingCycleId
integer <int64> (IdParam) >= 1

Filter by billing cycle id

Example: billingCycleId=1
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "billingCycleId": 1,
    • "created": "2019-08-24",
    • "periodStartDate": "2019-08-24",
    • "periodEndDate": "2019-08-24",
    • "invoiceDate": "2019-08-24",
    • "billRunStatus": "OPEN",
    • "summaryStatus": "PROPERTIES",
    • "billingUserAdminId": 1,
    • "parallel": true,
    • "revenueInMajorCurrency": 1,
    • "usageSuspenseCount": 1,
    • "rentalSuspenseCount": 1,
    • "maxInvoiceValue": 0,
    • "maxInvoiceCustomerId": 1,
    • "paused": true
    }
]