get
https://api.etainabl.com/2.0/invoices/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve a single invoice by its ID.
Endpoint
GET /2.0/invoices/:idPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The invoice's unique identifier (ObjectId) |
Response
Returns a single invoice object with all available fields. See the Invoice object reference for the full list of fields.
{
"_id": "507f1f77bcf86cd799439011",
"fileName": "invoice-2024-01.pdf",
"status": "completed",
"financialStatus": "approved",
"completed": true,
"isPaid": false,
"values": {
"invoiceNumber": "INV-2024-001",
"supplierRef": "SUP-12345",
"supplierName": "British Gas",
"recipient": "Etainabl Ltd",
"invoiceDate": "2024-01-15T00:00:00.000Z",
"invoiceDueDate": "2024-02-15T00:00:00.000Z",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-31T00:00:00.000Z",
"meterPointNumber": "1234567890123",
"meterSerialNumber": "E12345678",
"totalUnits": 15000,
"totalUnitCost": 1500.00,
"totalDaily": 45.50,
"totalCCL": 120.00,
"netTotalCost": 1665.50,
"totalTax": 333.10,
"totalCost": 1998.60,
"units": "kwh",
"startRead": "45000",
"endRead": "60000",
"startReadType": "actual",
"endReadType": "actual",
"supplyAddress": "123 Main Street, London, EC1A 1BB"
},
"rates": [
{
"id": "rate-001",
"rateName": "Day Rate",
"consumption": 10000,
"unitRate": 0.12,
"cost": 1200.00,
"units": "kwh",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-31T00:00:00.000Z"
}
],
"notes": "",
"accountId": "507f1f77bcf86cd799439012",
"entityId": "507f1f77bcf86cd799439013",
"supplierId": "507f1f77bcf86cd799439014",
"createdAt": "2024-02-01T09:30:00.000Z",
"updatedAt": "2024-02-05T14:15:00.000Z"
}Example Request
curl -X GET "https://api.etainabl.com/2.0/invoices/507f1f77bcf86cd799439011" \
-H "x-api-key: YOUR_API_KEY"Scope Required
read:invoices