Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Statements

List Statements

Get a list of statements in the Arcadia system. This endpoint does not return any line item charges or usages regardless of contribution status. This endpoint is pageable.

This endpoint supports Sandbox Mode.

get/plug/statements

Query parameters

searchstring

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
globalSearchstring

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

isCrossVersionSearchboolean

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.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

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

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK