Unlock Bill (entirely or partially) by ID

post

https://bayou.energy/api/v2/bills/{id}/unlock

Unlocks a specific utility bill, entirely or partially, by specifying its ID and optional filters on meters to unlock

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Can be either Bayou's numeric ID or your own identifier for this bill preceded with external_id:

Body Params

meter_id

string

Filter to unlock the bill for a specific meter ID. If not provided, no meter ID filter is applied.

billing_period_from

date

Filter to unlock the bill for meters with a billing period starting on or after this date. If not provided, no start date filter is applied.

billing_period_to

date

Filter to unlock the bill for meters with a billing period ending on or before this date. If not provided, no end date filter is applied.

type

string

enum

Filter to unlock the bill for meters of this type. If not provided, no meter type filter is applied.

Allowed:

additional_attributes

object

Filter to unlock the bill for meters with these additional attributes. If not provided, no additional attribute filter is applied.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The utility bill was unlocked