HomeGuidesAPI ReferenceChangelog
Log In
API Reference
Start typing to search…

List Statements

get https://api.arcadia.com/plug/statements

Get a list of statements in the Arcadia system. This endpoint is pageable.

This endpoint supports Sandbox Mode.

Log in to see full request history
Query Params
string

A search query string. See this page for more information.

The searchable fields for this endpoint are:

  • accountIds
  • accountNumbers
  • amountDue
  • correlationIds
  • createdAt
  • credentialIds
  • dataIngestionMethod
  • discoveredAt
  • dueDate
  • id
  • invoiceNumber
  • lastModifiedAt
  • meterIds
  • meterNumbers
  • normalizedAccountNumbers
  • normalizedMeterNumbers
  • outstandingBalance
  • periodEndDate
  • periodStartDate
  • provider.name
  • providerId
  • siteIds
  • siteNames
  • statementDate
  • summaryAccountNumber
  • totalCharges
  • type
string

A global search query string. See this page for more information.

integer
Defaults to 0

Zero-based page index (0..N)

integer
Defaults to 20

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Headers
string
required
Defaults to 2024-02-21

The Arcadia-Version for the request

Response

Response body
object
page
object
required

Specifies which page of results to return; this is 0-indexed

int64
required
int64
required
int64
required
int64
required
statements
array of objects
required

An array of statement objects.

statements*
object
accountData
array of objects
required

Data related to individual accounts, including billing information, usage history, etc.

accountData*
object
string
required

An unique identifier for an account.

string
required

An account identifier provided by the commodity provider (often times the bill publisher).

number | null
required

The monetary amount that is required to be paid.

date | null
required

The due date for payment associated with the account.

meterData
array of objects
required

meterData: Data related to individual meters, including meter readings, usage history, etc.

meterData*
object
number | null
required

The monetary amount that is required to be paid.

string | null
required

The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.

USD AUD CAD EUR GBP ZAR RON BRL DKK CHF MXN NZD NOK SEK CZK COP PLN ARS GTQ SGD TRY INR JPY HKD HUF AED MAD PHP IDR UYU CLP PEN MYR OMR BHD SAR GHS THB VND LKR KRW BAM BGN RSD TWD KES NGN ILS

string
required

A unique identifier for a meter.

string | null
required

A number assigned to the meter by the commodity provider.

date | null
required

The date on which the meter reading was taken.

string | null
required

The normalized version of the meter number (removing things like hyphens, underscores, and leading zeros).

string | null
required

The normalized version of the Point of Delivery number (removing things like hyphens, underscores, and leading zeros).

number | null
required

The remaining balance yet to be paid for the account.

string | null
required

The point of delivery number in deregulated markets is an independent identifier for meter location and used by all utility companies.

date | null
required

The date of the previous meter reading.

string
required

The type of service supported, such as electricity, water, or gas.

string
required

The classification for the service type depending on the comprehensiveness of data that can be returned.

CORE SUPPLEMENTAL

number | null
required

The total charges applied for a specific billing period.

number | null
required

Total calculated usage of energy or water for the account within a specific period.

string | null
required

Unit of measurement for the total calculated usage (e.g., kWh, gallons).

string
required

The normalized version of the account number (removing things like hyphens, underscores, and leading zeros).

number | null
required

The remaining balance yet to be paid for the account.

provider
object
required

This resource represents the provider for an account data entry on a statement. In the statement context, the publisher provider is the provider that posts the bill whereas the pass-through provider is one that is listed on the bill but does not post it.

number | null
required

The total charges applied for a specific billing period.

number | null
required

The monetary amount that is required to be paid.

correlationIds
array of strings
required

A list of correlationIds cascaded from all directly associated Credentials and Files.

correlationIds*
date-time | null
required

A timestamp indicating when the entity was created.

string | null
required

The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.

USD AUD CAD EUR GBP ZAR RON BRL DKK CHF MXN NZD NOK SEK CZK COP PLN ARS GTQ SGD TRY INR JPY HKD HUF AED MAD PHP IDR UYU CLP PEN MYR OMR BHD SAR GHS THB VND LKR KRW BAM BGN RSD TWD KES NGN ILS

string | null
required

Identifies the data ingestion method that created this Statement.

BILL_UPLOAD UTILITY_WEBSITE_ACCESS

date-time | null
required

Timestamp indicating when the statement data was discovered and added to the system.

date | null
required

The due date for payment associated with the account.

string
required

A unique identifier for the entity.

string | null
required

The unique identifier or number assigned to a specific invoice.

string | null
required

The normalized version of the Summary account number (removing things like hyphens, underscores, and leading zeros).

number | null
required

The remaining balance yet to be paid for the account.

date | null
required

The end date of the measuring period.

date | null
required

The start date of the measuring period.

object | null
required

The entity providing service and issuing bills (informally known as a utility).

date | null
required

The date of the statement.

string | null
required

The number or identifier assigned to the summary account by the provider.

number | null
required

The total charges applied for a specific billing period.

string
required

Describes the source document.

BILL NOTICE ADJUSTMENT PREPAID

Updated about 1 year ago

Did this page help you?
Language
Credentials
OAuth2

Updated about 1 year ago

Did this page help you?