---
updatedAt: 2025-08-15T15:45:24.000Z
agentTools:
projectIndex: https://docs.arcadia.com/v1.0-Utility-Cloud/llms.txt
---
# List Statements
Get a list of statements in the Urjanet system. This endpoint is pageable.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Utility Cloud",
"description": "Utility Cloud",
"version": "2.0"
},
"servers": [
{
"url": "https://api.urjanet.com/"
}
],
"paths": {
"/utility/statements": {
"get": {
"tags": [
"Statements"
],
"description": "Get a list of statements in the Urjanet system. This endpoint is pageable.",
"operationId": "List Statements",
"summary": "List Statements",
"parameters": [
{
"name": "search",
"in": "query",
"description": "An RSQL query string (see here for details.) You can find a list of searchable fields here.",
"schema": {
"type": "string"
}
},
{
"description": "Zero-based page index (0..N)",
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"default": 0
}
},
{
"description": "The size of the page to be returned",
"in": "query",
"name": "size",
"schema": {
"type": "integer",
"default": 20
}
},
{
"description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPublicUtilityStatementResource"
}
},
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/PagedPublicUtilityStatementResource"
}
}
}
}
},
"security": [
{
"BearerAuth": []
},
{
"UnifiedAuth": []
},
{
"APIKey": []
}
]
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-amazon-apigateway-api-key-source": "AUTHORIZER",
"x-amazon-apigateway-binary-media-types": [
"application/pdf",
"application/zip",
"application/octet-stream"
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"UnifiedAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-amazon-apigateway-authtype": "custom",
"x-amazon-apigateway-authorizer": {
"authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:291789168161:function:${stageVariables.authenticatorFunctionName}/invocations",
"authorizerCredentials": "arn:aws:iam::291789168161:role/${stageVariables.authenticatorRoleName}",
"authorizerResultTtlInSeconds": 300,
"type": "token"
}
},
"APIKey": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
}
},
"schemas": {
"PageMetadata": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int64"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int64"
}
},
"title": "PageMetadata"
},
"PagedPublicUtilityStatementResource": {
"required": [
"_embedded",
"_links",
"page"
],
"properties": {
"_embedded": {
"properties": {
"statements": {
"items": {
"$ref": "#/components/schemas/PublicUtilityStatementResource"
},
"type": "array"
}
},
"type": "object"
},
"_links": {
"properties": {
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"prev": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
},
"title": "PagedPublicUtilityStatementResource",
"type": "object"
},
"PublicUtilityStatementResource": {
"required": [
"accountIds",
"accountNumbers",
"amountDue",
"amountDueAfterDueDate",
"amountDueBeforeDueDate",
"correlationId",
"createdDate",
"credentialIds",
"customerNumber",
"cycleNumber",
"disconnectDate",
"discountBeforeDueDate",
"discoveredDate",
"dueDate",
"finalBillNotice",
"entityId",
"invoiceNumber",
"lastModifiedDate",
"meterNumbers",
"newCharges",
"normalizedSummaryAccountNumber",
"origin",
"outstandingBalance",
"periodEnd",
"periodStart",
"previousBalance",
"previousStatementDate",
"provider",
"providerName",
"siteNames",
"sourceType",
"statementDate",
"statementType",
"summaryAccountNumber",
"totalCharges"
],
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the account IDs (UUID) within this statement. There is no max length for this field. This field is searchable."
},
"accountNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the account numbers within this statement. There is no max length for this field. This field is searchable."
},
"amountDue": {
"type": "number",
"nullable": true,
"description": "This field is searchable"
},
"amountDueAfterDueDate": {
"type": "number",
"nullable": true
},
"amountDueBeforeDueDate": {
"type": "number",
"nullable": true
},
"correlationId": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"createdDate": {
"format": "date-time",
"type": "string",
"description": "This field is searchable"
},
"customerNumber": {
"type": "string",
"nullable": true
},
"cycleNumber": {
"type": "string",
"nullable": true
},
"disconnectDate": {
"format": "date",
"type": "string",
"nullable": true
},
"discountBeforeDueDate": {
"type": "number",
"nullable": true
},
"discoveredDate": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"dueDate": {
"format": "date",
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"entityId": {
"type": "string",
"description": "Statement ID (UUID)"
},
"finalBillNotice": {
"type": "string",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"lastModifiedDate": {
"format": "date-time",
"type": "string",
"description": "This field is searchable"
},
"meterNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the meter numbers within this statement. There is no max length for this field. This field is searchable."
},
"newCharges": {
"type": "number",
"nullable": true
},
"normalizedSummaryAccountNumber": {
"type": "string",
"nullable": true
},
"outstandingBalance": {
"type": "number",
"nullable": true,
"description": "This field is searchable"
},
"periodEnd": {
"format": "date",
"type": "string"
},
"periodStart": {
"format": "date",
"type": "string"
},
"previousBalance": {
"type": "number",
"nullable": true
},
"previousStatementDate": {
"format": "date",
"nullable": true,
"type": "string"
},
"provider": {
"$ref": "#/components/schemas/PublicUtilityProviderResource"
},
"providerAlias": {
"type": "string",
"description": "This field is searchable"
},
"providerName": {
"type": "string",
"description": "This field is searchable"
},
"sourceType": {
"enum": [
"TAG_NAME",
"UNCLASSIFIED",
"HTML",
"CSS",
"PNG",
"JPG",
"GIF",
"TIFF",
"SVG",
"WEBP",
"ICO",
"PDF",
"JSON",
"CSV",
"XML",
"XLS",
"XLSX",
"TXT",
"ZIP",
"MSOTF",
"OTF",
"SFNT",
"TTF",
"WOFF",
"WOFF2",
"FONT_WOFF",
"FONT_WOFF2",
"FONT_XWOFF",
"FONT_TTF",
"FONT_SFNT",
"URJA_NODE_LIST",
"URJA_NAV_HISTORY",
"INSERT_BILL",
"EDI",
"X12",
"WOOT"
],
"type": "string",
"nullable": true
},
"statementDate": {
"format": "date",
"type": "string",
"description": "This field is searchable",
"nullable": true
},
"statementType": {
"enum": [
"BILL",
"NOTICE",
"ADJUSTMENT",
"PREPAID"
],
"type": "string"
},
"summaryAccountNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"totalCharges": {
"type": "number",
"nullable": true,
"description": "This field is searchable"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"accounts": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"source": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
},
"title": "PublicUtilityStatementResource",
"type": "object"
},
"PublicUtilityProviderResource": {
"required": [
"country",
"id",
"providerName",
"supportsCredentialValidation",
"website"
],
"properties": {
"country": {
"type": "string",
"nullable": true,
"description": "The provider's country"
},
"entityId": {
"type": "string",
"description": "The ID of the provider"
},
"providerName": {
"type": "string",
"description": "The provider's name"
},
"supportsCredentialValidation": {
"type": "boolean",
"nullable": true,
"description": "Whether or not the provider supports credential validation"
}
},
"title": "PublicUtilityProviderResource",
"type": "object"
}
}
},
"tags": [
{
"name": "Statements"
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true,
"samples-enabled": true
}
}
```