Update a specific adhoc bill run

patch/adhoc-bill-runs/{adhoc_bill_run_id}

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

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

Adhoc 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": "/summaryStatus",
    • "value": "REPORTING"
    },
  • {
    • "op": "replace",
    • "path": "/invoiceDate",
    • "value": "2023-02-04"
    },
  • {
    • "op": "replace",
    • "path": "/nickname",
    • "value": "Maintenance Charge"
    }
]
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "nickname": "string",
  • "created": "2019-08-24",
  • "invoiceDate": "2019-08-24",
  • "billRunStatus": "OPEN",
  • "summaryStatus": "PROPERTIES",
  • "summaryStatusPercentage": 100,
  • "billingUserAdminId": 1,
  • "revenueInMajorCurrency": 1,
  • "adhocProductInventoryIds": [
    • 1
    ],
  • "rentalProductInventoryIds": [
    • 1
    ]
}