Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Accounts

Create Account Through Third Party Portal

Create a new account in the Arcadia system. This is used for providers that support third party portals for indirect account access. Rather than submitting utility login credentials, you would submit account numbers. The end user will receive an email and have to approve access before Arcadia can read information from the provider.

This endpoint supports Sandbox Mode.

post/plug/accounts

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

accountNumberstring required

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

correlationIdstring

A string value you can set to help you reconcile with your internal systems.

isActiveboolean

Indicates whether the Account is active for applicable products.

providerIdstring required

The unique identifier of the utility service provider.

Response

OK

accountNumberstring required

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

billingCycle'MONTHLY' | 'BIMONTHLY' | 'QUARTERLY' | 'TRIANNUALLY' | 'HALF_YEARLY' | 'YEARLY' | 'ABNORMAL' nullable required

The expected billing cycle. Determined by the service period of the most recent Statement.

correlationIdsstring[] required

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

createdAtstring date-time required

A timestamp indicating when the entity was created.

createdBystring nullable required

User or system responsible for creating the entity.

customDataPublicCustomDataResource required

You can use these fields to specify additional metadata.

firstExtractedAtstring date-time nullable required

The timestamp for when data was first extracted for the account.

idstring required

A unique identifier for the entity.

isAccessibleboolean required

Indicates whether the Account has at least one Credential associated with it in an accessible status detail.

isCustomerActionRequiredboolean required

Indicates whether any action is required from you regarding this resource.

isHistoryFulfilledboolean required

If true, all Statement Gaps for this Account are EXPECTED, or Statement Gaps are not applicable for the Account, such as summary Accounts or Accounts without any CORE serviceTypeClassification Meters. If false, there is at least one Statement Gap that is not EXPECTED or the gaps are pending computation.

isIntervalsThirdPartyPortalAccountboolean required

Indicates whether or not this account is enrolled under an intervals third party portal.

isStatementsProductActiveboolean required

Indicates whether the Plug Statements product is active for this account.

lastModifiedAtstring date-time nullable required

The timestamp indicating when this resource was last modified.

lastModifiedBystring nullable required

The user or system that last modified this resource.

lastSuccessfulStatementExtractionAtstring date-time nullable required

The timestamp indicating the most recent successful data extraction.

latestNewStatementAtstring date-time nullable required

The timestamp indicating the most recent new statement received for the account.

latestStatementDatestring date nullable required

The date of the most recent statement.

nextExpectedPostDatestring date nullable required

The date we expect to see a new statement for this account.

normalizedAccountNumberstring required

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

prepaidboolean required

Indicates whether the account operates on a prepaid basis, where services are paid for in advance.

providerClassification'PUBLISHER' | 'PASS_THROUGH' nullable required

Indicates whether this account is associated with the publisher or pass-through provider on the bill.

siteNamesstring[] required

An array of names for Sites.

status'NEW_ACCOUNT' | 'CONNECTION_SUCCESS' | 'CONNECTION_IN_PROGRESS' | 'DATA_ACCESS_FAILURE' | 'INACTIVE' | 'CONNECTION_DEACTIVATED' required

Status of the resource.

statusDetail'DATA_ACCESSIBLE' | 'ISSUE_UNDER_REVIEW' | 'CREDENTIAL_ISSUE' | 'NO_DATA_AVAILABLE' | 'NO_BILLS_DISCOVERED_AFTER_MOST_RECENT_NEXT_EXPECTED_POST_DATE' | 'NO_BILLS_DISCOVERED_AFTER_FINAL_BILL_NOTICE' | 'EMAIL_APPROVAL' | 'UNSUCCESSFUL_EMAIL_APPROVAL' | 'USER_REVOKED_ACCESS' | 'STATEMENT_EXTRACTION_NOT_REQUESTED' required

Reason the resource has the current status.

summaryAccountIdstring nullable required

The unique identifier of the summary account.

summaryAccountNumberstring nullable required

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

totalMetersinteger required

Total number of meters associated with this account.

type'NORMAL' | 'SUMMARY' | 'SUB_ACCOUNT' required

Indicates the type of the account.

voidedAtstring date-time nullable required

A timestamp indicating when the entity was voided. This value resets to null if the entity is unvoided. See event history for additional context.