The Invoice object represents a utility invoice/bill in the Etainabl system.
Top-level Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
_id | ObjectId | - | Auto | Unique identifier |
fileName | string | No | - | Original file name |
status | string | No | - | Processing status: processing, pending, uploading, queued, captured, error, completed |
financialStatus | string | No | - | Financial status: approved, new, not-approved, paid, sent-for-payment |
completed | boolean | No | - | Whether the invoice has been fully processed |
type | string | No | - | Invoice type |
tags | array[string] | No | - | Tags for categorisation |
isPaid | boolean | No | - | Whether the invoice has been paid |
simulated | boolean | No | - | Whether this is a simulated invoice |
notes | string | No | - | Additional notes |
assignedTo | string | No | - | Assigned user |
noScrape | boolean | No | false | Whether to skip scraping for this invoice |
confirmedAt | date | No | - | Date the invoice was confirmed |
confirmedBy | string | No | - | User who confirmed the invoice |
values | object | No | - | Invoice values (see below) |
rates | array[object] | No | - | Invoice rates (see below) |
supplierId | ObjectId | No | - | Supplier ID |
batchId | string | No | - | Batch ID (from data import) |
accountId | ObjectId | No | - | Account (meter) ID |
entityId | ObjectId | No | - | Entity ID |
invoiceValidationId | ObjectId | No | - | Invoice validation ID |
captureMeterId | string | No | - | Capture meter ID |
createdAt | date | - | Auto | Creation timestamp |
updatedAt | date | - | Auto | Last update timestamp |
Invoice Values Object
The values object contains the financial and metering details of the invoice.
| Field | Type | Description |
|---|---|---|
invoiceNumber | string | Invoice number |
supplierRef | string | Supplier reference |
recipient | string | Invoice recipient |
supplierName | string | Supplier name |
startDate | date | Billing period start |
endDate | date | Billing period end |
invoiceDate | date | Invoice issue date |
invoiceDueDate | date | Payment due date |
invoiceStartDate | date | Invoice start date |
invoiceEndDate | date | Invoice end date |
supplierVatNumber | string | Supplier VAT number |
meterPointNumber | string | MPAN/MPRN |
meterPointNumber2 | string | Secondary meter point number |
meterSerialNumber | string | Meter serial number |
totalUnitCost | number | Total unit cost |
totalWaterCost | number | Total water cost |
totalWasteCost | number | Total waste cost |
totalDaily | number | Total daily/standing charge |
totalLevy | number | Total levy charges |
totalCCL | number | Total Climate Change Levy |
totalMisc | number | Total miscellaneous charges |
totalFeedInTariff | number | Total Feed-in Tariff |
totalLatePayment | number | Total late payment charges |
totalKva | number | Total KVA charges |
totalUnits | number | Total units consumed |
totalWaterVolume | number | Total water volume |
totalWasteVolume | number | Total waste volume |
capacity | number | Capacity |
netTotalCost | number | Net total cost (before tax) |
totalTax | number | Total tax amount |
totalCost | number | Gross total cost |
sewerageReturnPercentage | number | Sewerage return percentage |
calorificValue | string | Calorific value (gas) |
correctionFactor | string | Correction factor (gas) |
readFactor | string | Read factor |
type | string | Type |
startRead | string | Start meter reading |
endRead | string | End meter reading |
startReadType | string | Start read type (e.g. actual, estimated) |
endReadType | string | End read type (e.g. actual, estimated) |
isFinal | boolean | Whether this is a final invoice |
units | string | Units. See Units |
supplyAddress | string | Supply address |
contractEndDate | date | Contract end date |
contractNoticeDate | date | Contract notice date |
invoiceValuesComment | string | Comment on invoice values |
meterValuesComment | string | Comment on meter values |
Invoice Rates Array
Each element in the rates array represents a line item/rate on the invoice.
| Field | Type | Description |
|---|---|---|
id | string | Rate identifier |
rateName | string | Rate name (e.g. Day Rate, Night Rate) |
contractRateName | string | Contract rate name |
consumption | number | Consumption for this rate |
unitRate | number | Unit rate (price per unit) |
cost | number | Cost for this rate line |
startRead | string | Start read for this rate |
startReadType | string | Start read type |
endRead | string | End read for this rate |
endReadType | string | End read type |
register | string | Register |
units | string | Units |
type | string | Rate type |
startDate | date | Rate period start |
endDate | date | Rate period end |
comment | string | Comment |