Update a specific bill run

patch/bill-runs/{bill_run_id}

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

SecuritybearerAuth
Request
path Parameters
bill_run_id
required
integer <int64> (IdParam) >= 1

Bill run identifier

Example: 1
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

Success

400

Invalid Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "replace",
    • "path": "/billRunStatus",
    • "value": "CLOSED"
    },
  • {
    • "op": "replace",
    • "path": "/summaryStatus",
    • "value": "REPORTING"
    },
  • {
    • "op": "replace",
    • "path": "/invoiceDate",
    • "value": "2023-02-04"
    }
]
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "sortableName": "string",
  • "billingCycleId": 1,
  • "created": "2019-08-24",
  • "periodStartDate": "2019-08-24",
  • "periodEndDate": "2019-08-24",
  • "invoiceDate": "2019-08-24",
  • "includeUsageUntilDate": "2019-08-24",
  • "billRunStatus": "OPEN",
  • "summaryStatus": "PROPERTIES",
  • "billingUserAdminId": 1,
  • "parallel": true,
  • "revenueInMajorCurrency": 1,
  • "usageSuspenseCount": 1,
  • "rentalSuspenseCount": 1,
  • "maxInvoiceValue": 0,
  • "maxInvoiceCustomerId": 1,
  • "paused": true
}