HomeGuidesAPI ReferenceChangelog
Log In
API Reference

List Detailed Statements

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

This endpoint supports Sandbox Mode.

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
  • discoveredStatementId
  • dueDate
  • hasValidAccountStatus
  • id
  • invoiceNumber
  • isLatestVersion
  • lastModifiedAt
  • meterIds
  • meterNumbers
  • normalizedAccountNumbers
  • normalizedMeterNumbers
  • outstandingBalance
  • periodEndDate
  • periodStartDate
  • provider.name
  • providerId
  • siteIds
  • siteNames
  • statementDate
  • summaryAccountNumber
  • totalCharges
  • type
  • versionId
string

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

boolean
Defaults to false

If true, the response will search against all versions of Statements instead of only the latest versions. If the search returns multiple hits for a single Statement, only the latest Statement version out of the hits for that Statement is returned.

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

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json