v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Accounts

List Detailed Accounts

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

This endpoint supports Sandbox Mode.

get/plug/accounts/details

Query parameters

searchstring

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

The searchable fields for this endpoint are:

  • accountNumber
  • billingCycle
  • correlationIds
  • createdAt
  • credentialIds
  • customData1
  • customData10
  • customData11
  • customData12
  • customData13
  • customData14
  • customData15
  • customData16
  • customData17
  • customData18
  • customData19
  • customData2
  • customData20
  • customData21
  • customData22
  • customData23
  • customData24
  • customData25
  • customData3
  • customData4
  • customData5
  • customData6
  • customData7
  • customData8
  • customData9
  • firstExtractedAt
  • gapSummary.earliestGapStartDate
  • gapSummary.gaps.endDate
  • gapSummary.gaps.startDate
  • gapSummary.gaps.status
  • gapSummary.gaps.statusDetail
  • gapSummary.isCustomerActionRequired
  • gapSummary.latestGapStartDate
  • id
  • isAccessible
  • isCustomerActionRequired
  • isHistoryFulfilled
  • isStatementsProductActive
  • lastModifiedAt
  • lastModifiedBy
  • lastSuccessfulExtractionAt
  • latestNewStatementAt
  • latestStatementDate
  • meterIds
  • nextExpectedPostDate
  • normalizedAccountNumber
  • origin
  • prepaid
  • provider.name
  • provider.providerId
  • providerClassification
  • serviceTypes
  • siteIds
  • siteNames
  • statementIds
  • status
  • statusDetail
  • summaryAccount
  • summaryAccountId
  • summaryAccountNumber
  • totalMeters
  • type
  • username
  • voidedAt
globalSearchstring

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

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