---
updatedAt: 2026-08-28T15:01:18.000Z
agentTools:
projectIndex: https://developer.getbright.se/llms.txt
---
# Get account invoices
Returns an array of invoices associated with the `accountId`.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Bright Kit",
"version": "v1.0",
"contact": {
"name": "Bright Energy",
"url": "https://www.getbright.se",
"email": "support@getbright.se"
},
"description": "
\n![](\"https://bright-documentation-assets.s3.eu-north-1.amazonaws.com/bright-kit-logo.svg\")
\n\nThe following API specification is a blueprint for Bright Energy partners.\n\nPartners are required to create and expose these endpoints only to Bright Energy for fetching user data. This enables users to access your applications and all embedded features.\n",
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
},
"summary": "Bright Kit"
},
"servers": [
{
"url": "https://{kitEnvironment}.{kitDomain}/{kitBasePath}",
"description": "Variable based url structure.\n\n`kitDomain`: The domain the Bright Kit is deployed to.\n\n`kitEnvironment`: The environment to target your requests. `staging` shall be used for integration and testing purposes.\n\n`kitBasePath`: Use v1 currently.\n",
"variables": {
"kitDomain": {
"default": "domain"
},
"kitEnvironment": {
"default": "staging"
},
"kitBasePath": {
"default": "v1"
}
}
}
],
"tags": [
{
"name": "invoices",
"description": "Invoices for services that have been consumed by users."
}
],
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
}
],
"externalDocs": {
"description": "Bright Energy Developer Hub",
"url": "https://developer.getbright.se"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Can be the obtained token from an approved authorization method (Oauth or OpenId) or a pre-generated token given to Bright Energy. Tokens must be environment specific. JWT supported."
},
"apiKey": {
"type": "apiKey",
"name": "apiKey",
"in": "header",
"description": "API key that is environment specific."
}
},
"responses": {
"BadRequest": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"name": "BadRequestError",
"message": "The request was malformed.",
"status": 400,
"error": true,
"key": "BadRequestError",
"uid": "y9g1f21f-a740-4346-9a79-3800fe8c8644"
}
}
}
},
"Forbidden": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"name": "ForbiddenError",
"message": "Invalid Token.",
"status": 401,
"error": true,
"key": "TOKEN_INVALID",
"uid": "a9c1f21f-a740-4346-9a79-3800fe8c8652"
}
}
}
},
"NotFound": {
"description": "Resource Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"name": "NotFoundError",
"message": "The resource was not found.",
"status": 404,
"error": true,
"key": "NotFoundError",
"uid": "a9c1f21f-a740-4346-9a79-3800fe8c8652"
}
}
}
}
},
"schemas": {
"ISO8601": {
"type": "string",
"minLength": 19,
"format": "date-time",
"pattern": "^(-?(?:[1-9][0-9]*)?[0-9]{4})(-(1[0-2]|0[1-9]))?(-(3[01]|0[1-9]|[12][0-9]))?(T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])((.[0-9]+)?|([+-](2[0-3]|[01][0-9]):([0-5][0-9]))))?(Z)?$",
"title": "ISO8601",
"description": "A field which should comply with the ISO 8601 standard.",
"examples": [
"2023-10-20T15:30:30+02:00",
"2023-10-20T11:30:30.000Z"
]
},
"Error": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"examples": [
"GenericError"
]
},
"message": {
"type": "string",
"minLength": 1,
"examples": [
"An error of some origin has occurred."
]
},
"status": {
"type": "number",
"format": "int32",
"minimum": 400,
"maximum": 600,
"examples": [
400
]
},
"error": {
"type": "boolean",
"examples": [
true
]
},
"key": {
"type": "string",
"minLength": 1,
"examples": [
"GenericError"
]
},
"uid": {
"type": "string",
"minLength": 1,
"examples": [
"25198069-6171-410c-bfed-5e0666402c08"
]
}
},
"required": [],
"title": "Error",
"description": "The standard error object used in API responses",
"minProperties": 6
},
"InvoiceInfoValue": {
"type": "string",
"minLength": 1,
"title": "value",
"description": "The invoice line item text.",
"examples": [
"700 kr"
]
},
"InvoiceInfoTitle": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "The title in the correct language to be viewed.",
"examples": [
"Unique Line Item"
]
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceInfoValue"
},
{
"examples": [
"Line Item Text"
]
}
]
}
},
"required": [
"title"
],
"title": "InvoiceInfoTitle",
"description": "If sent, this will replace the key as the title for the value. It will not be translated."
},
"InvoiceInfoKey": {
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"description",
"ocr",
"period",
"dueDate",
"totalAmount",
"remainingAmount",
"status",
"invoiceNumber",
"invoiceDate"
],
"minLength": 1,
"description": "A key that will be translated into text according to the user's language preference.",
"examples": [
"remainingAmount"
]
},
"value": {
"$ref": "#/components/schemas/InvoiceInfoValue"
}
},
"required": [
"key"
],
"title": "InvoiceInfoKey",
"description": "Key based invoice info item. Translated to the user's language."
},
"InvoiceInfo": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/InvoiceInfoTitle"
},
{
"$ref": "#/components/schemas/InvoiceInfoKey"
}
]
},
"Invoice": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"examples": [
"70ce156f-5d85-4fc1-a6eb-638ea8f57f25"
]
},
"serviceId": {
"type": "string",
"minLength": 1,
"description": "If the invoice refers to a specific service.",
"examples": [
"5dbfbe59-a2a4-4caa-8717-32b22c0c492f"
]
},
"dueDate": {
"allOf": [
{
"$ref": "#/components/schemas/ISO8601"
},
{
"description": "The date-time the invoice is due for payment."
}
]
},
"invoiceDate": {
"allOf": [
{
"$ref": "#/components/schemas/ISO8601"
},
{
"description": "The date-time the invoice was created and sent out."
}
]
},
"period": {
"type": "string",
"enum": [
"1month",
"2month",
"3month",
"6month",
"12month"
],
"minLength": 1,
"description": "If the invoice is for 1 or more months.",
"examples": [
"1month"
]
},
"startDate": {
"allOf": [
{
"$ref": "#/components/schemas/ISO8601"
},
{
"description": "The date-time start date for the series of measurements the invoice covers."
}
]
},
"endDate": {
"allOf": [
{
"$ref": "#/components/schemas/ISO8601"
},
{
"description": "The date-time end date for the series of measurements the invoice covers, noninclusive."
}
]
},
"remainingAmount": {
"type": "number",
"format": "float",
"minimum": 0,
"description": "If the invoice has been partly paid. This value can be updated if the end customer makes several payments.",
"examples": [
354
]
},
"totalAmount": {
"type": "number",
"format": "float",
"minimum": 0,
"description": "The total amount of the invoice. This value should not change.",
"examples": [
1500
]
},
"invoiceStatus": {
"type": "string",
"enum": [
"unpaid",
"paid",
"paid_out",
"partly_paid",
"reminder",
"overdue",
"canceled",
"collection",
"deferred_with_intrest",
"deferred_without_intrest",
"investigation",
"credited",
"unknown"
],
"minLength": 1,
"description": "The status of the invoice.\n\nThe statuses listed below are supported by BrightKit.\n- `unpaid`: The invoice has been sent but is not yet paid.\n- `paid`: The invoice is paid in full.\n- `paid_out`: e.g. for production.\n- `partly_paid`: The invoice is only partly paid.\n- `reminder`: A payment reminder has been sent.\n- `overdue`: The last payment date has passed for an unpaid invoice.\n- `cancelled`: The invoice is no longer valid.\n- `collection`: The invoice has been handed to a collection agency.\n- `deferred_with_intrest`:\n- `deferred_without_intrest`:\n- `investigation`: The invoice is disputed or incorrect and needs to be investigated.\n- `credited`: The invoice has been credited.\n",
"examples": [
"unpaid"
]
},
"invoiceType": {
"type": "string",
"enum": [
"pdf",
"html",
"missing"
],
"minLength": 1,
"description": "The format of the invoice. Defaults to `missing`.\n- `html`: The invoice is a html page to be opened in a webview. Must use `Get account invoice url` endpoint.\n- `pdf`: A pdf as a bytestream. Must use `Get account invoice stream` endpoint.\n- `missing`: The invoice is not available.\n",
"examples": [
"pdf"
]
},
"info": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceInfo"
},
"minItems": 0
},
"eventType": {
"type": "string",
"enum": [
"invoice",
"payment"
],
"description": "The kind of event this record represents. Defaults to `invoice`. If both payments and invoices are present, they will be jointly sorted by the property invoiceDate.\n- `invoice`: An invoice that has been sent to the user.\n- `payment`: A payment made by the user, shown alongside invoices.\n",
"examples": [
"invoice"
]
}
},
"required": [
"id"
],
"title": "Invoice",
"examples": []
}
},
"parameters": {
"accountId": {
"schema": {
"type": "string",
"minLength": 1
},
"required": true,
"in": "path",
"name": "accountId",
"description": "The unique Id of the account.",
"example": [
"123456789"
]
},
"page": {
"schema": {
"type": "number",
"format": "int32",
"default": 1,
"minimum": 1
},
"in": "query",
"name": "page",
"description": "The page number to return in the response."
},
"limit": {
"schema": {
"type": "number",
"format": "int32",
"default": 100,
"minimum": 1,
"maximum": 1000
},
"in": "query",
"name": "limit",
"description": "The number of items per page."
},
"fromDate": {
"schema": {
"$ref": "#/components/schemas/ISO8601"
},
"required": true,
"description": "Start of the date range (inclusive).",
"in": "query",
"name": "fromDate"
},
"toDate": {
"schema": {
"$ref": "#/components/schemas/ISO8601"
},
"required": true,
"description": "End of the date range (exclusive).",
"in": "query",
"name": "toDate"
}
}
},
"paths": {
"/accounts/{accountId}/invoices": {
"get": {
"operationId": "get-account-invoices",
"summary": "Get account invoices",
"description": "Returns an array of invoices associated with the `accountId`.",
"tags": [
"invoices"
],
"parameters": [
{
"$ref": "#/components/parameters/accountId"
},
{
"$ref": "#/components/parameters/toDate"
},
{
"$ref": "#/components/parameters/fromDate"
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
},
"minItems": 0
},
"examples": {
"With results": {
"value": [
{
"id": "string",
"serviceId": "string",
"dueDate": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"period": "1month",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"remainingAmount": 0,
"totalAmount": 0,
"invoiceStatus": "unpaid",
"invoiceType": "pdf",
"info": [
{
"key": "ocr",
"value": "000129398234972"
},
{
"key": "invoiceNumber",
"value": "45343"
}
]
}
]
},
"Without results": {
"value": []
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
}
}
}
```