Create a new bill
Creates a bill.
The created bill gets audited.
If any audits fail, the bill will get flagged.
If the audit setting for any of the failed audits is set to Fail and Hold, the bill will be set as “Hold from Accounting Export”
If saveAsResolved property is set to true, the flagged bill will be automatically resolved and Released for Accounting Export
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| saveAsResolved | Controls whether or not any failed audits automatically get marked as resolved | boolean | Optional |
| comment | Optional comment to explain why the audit is being auto resolved | string | Optional |
Request Body
BillCreate
| Property | Description | Type | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accountBodyLines | The account line items | BillAccountBodyLineCreate[] | |||||||||||||||||||||||||||||||||
|
BillAccountBodyLineCreate properties
|
|||||||||||||||||||||||||||||||||||
| accountId | The bill’s account Required | integer (int32) | |||||||||||||||||||||||||||||||||
| accountPeriod | The bill’s accounting period Depending on your settings you can have up to 13 accounting periods Must be between 190001 and 209913 | integer (int32) | |||||||||||||||||||||||||||||||||
| batchId | Existing batch id to add this bill to, if applicable. If batchId is provided, it needs to be an open batch. If the batch is another user’s open batch, the permission “Bills and Batches:Manage” is required. If NOT provided, and current user has multiple open batches, the API will return an error. | integer (int32) | |||||||||||||||||||||||||||||||||
| beginDate | The bill’s begin date Required Must be between 1899-12-31 and 3000-01-01 | string (date-time) | |||||||||||||||||||||||||||||||||
| billingPeriod | The bill’s billing period Required Must be between 190001 and 209912 | integer (int32) | |||||||||||||||||||||||||||||||||
| controlCode | The bill’s control code Must be between 0 and 255 characters | string | |||||||||||||||||||||||||||||||||
| dueDate | The date and time the bill is due Must be between 1899-12-31 and 3000-01-01 | string (date-time) | |||||||||||||||||||||||||||||||||
| endDate | The bill’s end date Required Must be greater than BeginDate Must be between 1899-12-31 and 3000-01-01 | string (date-time) | |||||||||||||||||||||||||||||||||
| estimated | Indicates if the bill is estimated | boolean | |||||||||||||||||||||||||||||||||
| invoiceNumber | The bill’s invoice number Must be between 0 and 32 characters | string | |||||||||||||||||||||||||||||||||
| manualEntry | The bill’s entry method. True = manual entry, false = automatic entry. Required | boolean | |||||||||||||||||||||||||||||||||
| meters | The meters with line items | BillMeterCreate[] | |||||||||||||||||||||||||||||||||
|
BillMeterCreate properties
|
|||||||||||||||||||||||||||||||||||
| nextReading | The date and time the of the next reading Must be between 1899-12-31 and 3000-01-01 | string (date-time) | |||||||||||||||||||||||||||||||||
| note | The bill note | string | |||||||||||||||||||||||||||||||||
| statementDate | The date and time of the bill statement Must be between 1899-12-31 and 3000-01-01 | string (date-time) | |||||||||||||||||||||||||||||||||
Example Request Body
{ "accountBodyLines": [
{ "caption": "string", "cost": 1.0, "costUnitId": 1, "observationTypeId": 1, "specialChargeId": 1
}
], "accountId": 1, "accountPeriod": 1, "batchId": 1, "beginDate": "2026-03-30", "billingPeriod": 1, "controlCode": "string", "dueDate": "2026-03-30", "endDate": "2026-03-30", "estimated": false, "invoiceNumber": "string", "manualEntry": false, "meters": [
{ "bodyLines": [
{ "caption": "string", "cost": 1.0, "costUnitId": 1, "observationTypeId": 1, "value": 1.0, "valueUnitId": 1
}
], "meterId": 1
}
], "nextReading": "2026-03-30", "note": "string", "statementDate": "2026-03-30"
}
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
BillIdResponse
| Property | Description | Type |
|---|---|---|
| billId | The bill identifier | integer (int32) |
Example Response
{ "billId": 1
}