Arcadia

Arcadia Expected Accounts API

The Expected Accounts API from Arcadia — 1 operation(s) for expected accounts.

Documentation GitHub OpenAPI

Operations 2

GET /plug/expectedAccounts List Expected Accounts #

POST /plug/expectedAccounts Create Expected Account #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/arcadia-power:arcadia-power-expected-accounts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: Plug API
  title: Plug Expected Accounts API
  version: 2.0.0
servers:
- url: https://api.arcadia.com
security:
- OAuth2: []
tags:
- name: Expected Accounts
paths:
  /plug/expectedAccounts:
    get:
      description: Get a list of expected accounts in the Arcadia system. This endpoint is pageable.
      operationId: list-expected-accounts
      parameters:
      - description: 'A search query string. See [this page](ref:searching) for more information.


          The searchable fields for this endpoint are:

          - `businessUnits.id`

          - `businessUnits.name`

          - `expectedAccountNumber`

          - `normalizedExpectedAccountNumber`

          - `providerId`

          - `providerName`'
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: A global search query string. See [this page](ref:searching#global-search) for more information.
        in: query
        name: globalSearch
        required: false
        schema:
          type: string
      - description: Business Unit IDs to filter Expected Accounts by.
        in: query
        name: businessUnitIds
        required: false
        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
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedPublicExpectedAccountResource'
          description: Successfully retrieved expected accounts
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedPublicExpectedAccountResource'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedPublicExpectedAccountResource'
          description: Forbidden
      summary: List Expected Accounts
      tags:
      - Expected Accounts
    post:
      description: This endpoint allows you to create a new expected account in the Arcadia system.
      operationId: create-expected-account
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicExpectedAccountRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExpectedAccountResource'
          description: Expected account successfully created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExpectedAccountResource'
          description: Invalid request body
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExpectedAccountResource'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExpectedAccountResource'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExpectedAccountResource'
          description: Provider not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExpectedAccountResource'
          description: Expected account already exists
      summary: Create Expected Account
      tags:
      - Expected Accounts
      parameters:
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
components:
  schemas:
    PagedPublicExpectedAccountResource:
      type: object
      properties:
        expectedAccounts:
          type: array
          description: An array of the expected accounts that satisfied the search criteria
          items:
            $ref: '#/components/schemas/PublicExpectedAccountResource'
        page:
          $ref: '#/components/schemas/PageMetadata'
      required:
      - expectedAccounts
      - page
    PublicCustomDataResource:
      type: object
      description: You can use these fields to specify additional metadata.
    PublicBusinessUnitResource:
      type: object
      description: A business unit assignment.
      properties:
        id:
          type: string
          description: Business unit identifier.
          readOnly: true
        name:
          type:
          - string
          - 'null'
          description: Display name when visible to the caller.
      required:
      - id
      - name
    PageMetadata:
      required:
      - number
      - size
      - totalElements
      - totalPages
      type: object
      properties:
        number:
          type: integer
          format: int64
        size:
          type: integer
          format: int64
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
      description: Specifies which page of results to return; this is 0-indexed
    PublicExpectedAccountResource:
      type:
      - object
      - 'null'
      properties:
        businessUnits:
          type: array
          description: Business Units directly assigned to the Expected Account.
          items:
            $ref: '#/components/schemas/PublicBusinessUnitResource'
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
          description: The timestamp when the expected account was created.
        createdBy:
          type:
          - string
          - 'null'
          description: The user who created the expected account.
        customData:
          $ref: '#/components/schemas/PublicCustomDataResource'
        expectedAccountNumber:
          type:
          - string
          - 'null'
          description: The expected account number associated with the expected account.
        id:
          type: string
          description: A unique identifier for the expected account.
        lastModifiedAt:
          type:
          - string
          - 'null'
          format: date-time
          description: The timestamp when the expected account was last modified.
        lastModifiedBy:
          type:
          - string
          - 'null'
          description: The user who last modified the expected account.
        normalizedExpectedAccountNumber:
          type:
          - string
          - 'null'
          description: The normalized expected account number associated with the expected account.
        providerId:
          type:
          - string
          - 'null'
          description: The provider ID associated with the expected account.
        providerName:
          type:
          - string
          - 'null'
          description: The name of the utility service provider.
      required:
      - businessUnits
      - createdAt
      - createdBy
      - customData
      - expectedAccountNumber
      - id
      - lastModifiedAt
      - lastModifiedBy
      - normalizedExpectedAccountNumber
      - providerId
      - providerName
    PublicExpectedAccountRequest:
      type: object
      properties:
        businessUnitIds:
          type: array
          description: Business Unit IDs to pre-assign to this Expected Account.
          items:
            type: string
            description: Business Unit IDs to pre-assign to this Expected Account.
        customData:
          type: object
          additionalProperties:
            type: string
            description: The custom data for the expected account.
          description: The custom data for the expected account.
        expectedAccountNumber:
          type: string
          description: An account identifier provided by the commodity provider (often times the bill publisher).
          maxLength: 255
          minLength: 0
        providerId:
          type: string
          description: The unique identifier of the utility service provider.
          minLength: 1
      required:
      - expectedAccountNumber
      - providerId
  parameters:
    arcVersionInHeaderParam:
      name: Arcadia-Version
      in: header
      example: '2024-02-21'
      description: The Arcadia-Version for the request
      required: true
      schema:
        type: string
        default: '2024-02-21'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: This API uses OAuth2 with the client credentials flow using the ['Create an Access Token'](ref:create-access-token) endpoint. API keys can be retrieved from the [Dashboard](https://dashboard.arcadia.com/).
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth2/token
x-provenance:
  method: harvested
  publisher: Arcadia
  source: https://docs.arcadia.com/openapi/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)

Arcadia Expected Accounts API

Operations 2

Documentation

Specifications

Schemas & Data

Other Resources