Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Meters

Create Meter through an Intervals Third Party Portal

Create a new meter in the Arcadia system. This is used for providers that support intervals third party portals for indirect account access. The end user will receive an email and have to approve access before Arcadia can read information from the provider.

post/plug/meters

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

correlationIdstring

An ID used to match the utility data pulled for this request back to users in your system. Correlation ID does not have to be unique.

electricServiceIdentifierstring required

The Electric Service Identifier (ESI ID) associated with the address for the meter.

meterNumberstring required

A meter identifier provided by the commodity provider (oftentimes the bill publisher).

providerIdstring required

The unique identifier of the utility service provider.

retailCustomerEmailstring email required

The customer email address associated with the account for the meter. An email will be sent to this email address to grant data sharing access.

Response

OK

bulbTypestring nullable required

Type or specification of light bulbs associated with the account, if applicable.

correlationIdsstring[] required

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

createdAtstring date-time nullable 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.

earliestIntervalAtstring date-time nullable required

A timestamp of the earliest interval available for the meter.

generalDescriptionAsPrintedstring nullable required

A general description of the account or service as printed on the bill.

idstring required

A unique identifier for the entity.

isIntervalsDormantboolean nullable required

Indicates whether the meter is dormant based on interval job results and error codes.

isIntervalsProductActiveboolean required

Indicates if intervals is activated for the meter.

isIntervalsThirdPartyPortalMeterboolean required

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

isLocationRecommendationIgnoredboolean required

Indicates whether or not location recommendation should be ignored.

isStandaloneboolean required

Indicates a meter is not expected to relate to a site.

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.

latestIntervalAtstring date-time nullable required

A timestamp of the latest interval available for the meter

latestIntervalsCheckedAtstring date-time nullable required

A timestamp of the most recent intervals check Arcadia attempted.

latestStatementDatestring date nullable required

The date of the most recent statement.

localTimezonestring nullable required

For meters that have intervals available, the meter's local timezone. The value can be any TZ identifier from this this list.

meterConstantMultipliernumber nullable required

The multiplier used to convert meter readings to actual usage values for the account. The first conversion after the meter delta is calculated

meterNumberstring nullable required

A number assigned to the meter by the commodity provider.

nextExpectedPostDatestring date nullable required

The expected date for the next statement to be posted for this account.

normalizedMeterNumberstring nullable required

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

normalizedPointOfDeliveryNumberstring nullable required

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

pipeTypestring nullable required

This field is only populated when the Service Type of the meter is water. This field describes the pipe type

pointOfDeliveryNumberstring nullable required

The point of delivery number in deregulated markets is an independent identifier for meter location and used by all utility companies.

previousMeterConstantMultipliernumber nullable required

The previous multiplier used to convert meter readings to actual usage values.

previousMeterNumberstring nullable required

The number assigned to the previous meter used.

serviceTypestring required

The type of service supported, such as electricity, water, or gas.

serviceTypeClassification'CORE' | 'SUPPLEMENTAL' required

The classification for the service type depending on the comprehensiveness of data that can be returned.

status'INTERVALS_NOT_REQUESTED' | 'INTERVALS_IN_PROGRESS' | 'INTERVALS_SUCCESS' | 'INTERVALS_FAILURE' | 'INTERVALS_NOT_SUPPORTED' | 'INTERVALS_PENDING' required

Status of the resource.

statusDetail'INTERVALS_EXTRACTION_NOT_REQUESTED' | 'INTERVALS_EXTRACTION_IN_PROGRESS' | 'INTERVALS_AVAILABLE' | 'INVALID_CREDENTIALS' | 'ACCOUNT_INACCESSIBLE' | 'INTERVALS_ACCESS_ERROR' | 'SERVICE_TYPE_NOT_SUPPORTED' | 'PROVIDER_NOT_SUPPORTED' | 'INTERVALS_NOT_PUBLISHED' | 'UTILITY_SITE_ERROR' | 'REQUIRES_ENROLLMENT' | 'EMAIL_APPROVAL' | 'UNSUCCESSFUL_EMAIL_APPROVAL' | 'USER_REVOKED_ACCESS' | 'INTERVALS_DISCOVERY_QUEUED' | 'INTERVALS_DISCOVERY_IN_PROGRESS' | 'INTERVALS_DISCOVERY_FAILED' required

Reason the resource has the current status.

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.