Authentication

Field Name	Description
`access_token`	The access token that can be used to access the Arcadia API. This token should be included in the “Authorization” header in the format “Bearer ACCESS_TOKEN".
`expires_in`	The number of seconds until the access token expires. Defaults to 3600 seconds (one hour).
`refresh_expires_in`	If one is provided, indicates the number of seconds until the refresh token expires. Currently, the refresh token grant type is not supported, so this value will always be 0.
`token_type`	Specifies the type of access token, per the OAuth2 spec. Always returns a value of “Bearer”, indicating the access token should be added to requests in the “Authorization” header in the format “Bearer ACCESS_TOKEN”.
`not-before-policy`	A timestamp that specifies the earliest time the access token is valid. A value of 0 means there is no restriction on when the token become valid, and can be used immediately.
`scope`	The scope of the access token. This will always currently be “profile email”.
`error`	A short description of the error that occurred.
`error_description`	A more descriptive, human-readable explanation of the error.

Credentials

Field Name	Description
`alternateAccesses`	List of alternate access methods (such as guest access) configured for this credential.
`connectionHealth`	A high-level connection health status that reflects the best outcome across the credential and all configured alternate access methods.
`correlationId`	A string value you can set to help you reconcile with your internal systems.
`createdAt`	A timestamp indicating when the entity was created.
`createdBy`	User or system responsible for creating the entity.
`customerGivenWebsite`	The website provided by the customer when creating this credential.
`id`	A unique identifier for the entity.
`isAccessible`	Indicates whether Arcadia is potentially able to successfully log into the Credential.
`isActive`	Indicates whether the Credential is active for applicable products.
`isCustomerActionRequired`	Indicates whether any action is required from you regarding this resource.
`isThirdPartyPortal`	Indicates whether the account requires to be accessed through a third-party portal or platform.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resource.
`lastSuccessfulMultiFactorAuthenticationOptOutAt`	The timestamp indicating when this Credential was last successfully opted out of Multi Factor Authentication.
`multiFactorAuthenticationOptOutStatus`	The status of Multi Factor Authentication Opt Out for the Credential.
`nextScheduledAccountRunAt`	The scheduled time for the next automated credential job.
`provider`	-
`status`	A high-level status for this credential. See this table for more information.
`statusDetail`	A detailed status for this credential. See this table for more information.
`totalAccounts`	The total number of accounts.
`username`	A login input required to access the customer's utility data
`username2`	Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider
`username3`	Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider
`username4`	Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider
`website`	The provider's website that this credential logs into.
`isInteractive`	For a provider that supports real time credential validation, you can create a credential with interactive set as true to receive feedback if the credential is valid or invalid.
`password`	A sensitive input required to access the customer's utility data. This will not be returned in any GET calls for the request object.
`password2`	Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.
`password3`	Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.
`password4`	Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.
`privacyPolicyUrl`	The URL to access the privacy policy you would like to use.
`providerId`	The unique identifier of the utility service provider.
`termsOfServiceUrl`	The URL for the terms of service you want to use.

Alternate Access

Fields nested within each item of the alternateAccesses array on a credential.

Field Name	Description
`id`	A unique identifier for the alternate access record.
`isActive`	Indicates whether this alternate access method is currently active.
`lastSuccessfulRefreshAt`	The timestamp indicating when this alternate access method was last successfully refreshed.
`status`	A high-level status for this alternate access method. See this table for more information.
`statusDetail`	A detailed status for this alternate access method. See this table for more information.
`type`	The type of alternate access method.

Accounts

Field Name	Description
`accountNumber`	An account identifier provided by the commodity provider (often times the bill publisher).
`billingCycle`	The expected billing cycle. Determined by the service period of the most recent Statement.
`correlationIds`	A list of correlationIds cascaded from all directly associated Credentials and Files.
`createdAt`	A timestamp indicating when the entity was created.
`createdBy`	User or system responsible for creating the entity.
`customData`	-
`firstExtractedAt`	The timestamp for when data was first extracted for the account.
`id`	A unique identifier for the entity.
`isAccessible`	Indicates whether the Account has at least one Credential associated with it in an accessible status detail.
`isCustomerActionRequired`	Indicates whether any action is required from you regarding this resource.
`isHistoryFulfilled`	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.
`isIntervalsThirdPartyPortalAccount`	Indicates whether or not this account is enrolled under an intervals third party portal.
`isStatementsProductActive`	Indicates whether the Plug Statements product is active for this account.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resource.
`lastSuccessfulStatementExtractionAt`	The timestamp indicating the most recent successful data extraction.
`latestNewStatementAt`	The timestamp indicating the most recent new statement received for the account.
`latestStatementDate`	The date of the most recent statement.
`nextExpectedPostDate`	The date we expect to see a new statement for this account.
`normalizedAccountNumber`	The normalized version of the account number (removing things like hyphens, underscores, and leading zeros).
`prepaid`	Indicates whether the account operates on a prepaid basis, where services are paid for in advance.
`provider`	-
`providerClassification`	Indicates whether this account is associated with the publisher or pass-through provider on the bill.
`serviceTypes`	An array of all types of service supported, such as electricity, water, or gas.
`siteNames`	An array of names for Sites.
`status`	Status of the resource.
`statusDetail`	Reason the resource has the current status.
`summaryAccountId`	The unique identifier of the summary account.
`summaryAccountNumber`	The number or identifier assigned to the summary account by the provider.
`type`	Indicates the type of the account.
`voidedAt`	A timestamp indicating when the entity was voided. This value resets to null if the entity is unvoided. See event history for additional context.
`accountId`	An unique identifier for an account.
`accountName1`	A general description associated with the name of the account. We obtain this description from the bill, when it is available. This field is not often populated. When it is populated, possible values you can expect are the name of the account owner, the name of the company, etc.
`accountName2`	Similar to the field `accountName1`, this is an additional general description associated with the name of the account. We obtain this description from the bill, when it is available. This field is rarely populated.
`amountDue`	The monetary amount that is required to be paid.
`amountDueAfterDueDate`	The total amount due for the account after the due date, excluding any late fees or penalties.
`amountDueBeforeDueDate`	The total amount due for the account before the due date, excluding any late fees or penalties.
`billingAddress`	-
`charges`	Details of charges applied, including amounts, currency, etc.
`currencyCode`	The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.
`customerNumber`	The bill contains a unique identifier for the customer associated with the account. This is not the account number
`cycleNumber`	The code or ID for a meter reading schedule.
`disconnectDate`	The date on which the service for the account was disconnected.
`discountBeforeDueDate`	Any discounts applied to the account if the outstanding balance is paid before the due date.
`dueDate`	The due date for payment associated with the account.
`facilityName`	The name of the facility indicated on the bill.
`facilityNumber`	A unique identifier for the facility indicated on the bill. This is not the account number.
`installmentDue`	The amount due for a specific installment payment associated with the account.
`installmentOutstanding`	The amount outstanding or remaining to be paid for a specific installment.
`invoiceNumber`	The unique identifier or number assigned to a specific invoice.
`mapNumber`	Like cycle number, the code or ID indicates a meter reading schedule.
`meterData`	meterData: Data related to individual meters, including meter readings, usage history, etc.
`newCharges`	Any new charges applied to the account since the last billing cycle or statement.
`outstandingBalance`	The remaining balance yet to be paid for the account.
`paymentAddress`	-
`periodEndDate`	The end date of the measuring period.
`periodStartDate`	The start date of the measuring period.
`previousBalance`	The balance carried forward from the previous billing period.
`statementDate`	The date of the statement.
`statementId`	The unique identifier of a statement.
`totalCharges`	The total charges applied for a specific billing period.
`usages`	Details of usage data.
`classification`	The classification of the provider. Useful to identify if this is a publisher or pass-through provider.
`name`	The name of the provider.
`publisherProviderAccountId`	A Publisher Provider issues the bill and a Pass-Though Provider is only mentioned on the bill. This is account ID of the Publisher Provider.
`addressType`	Enumeration of strings field that indicates the comprehensiveness of the address for an account.
`city`	The city associated with the billing address.
`country`	The country associated with the billing address.
`fullAddress`	The complete address associated with the account, including street address, city, postal code, and country.
`postalCode`	The postal code or ZIP code associated with the address of the account.
`recipient`	The recipient for the address.
`state`	The state or province associated with the billing address of the account.
`streetLine1`	The first line of the street address.
`streetLine2`	The second line of the street address.

Gap Summary

Fields nested under gapSummary on an Account.

Field Name	Description
`gaps`	A list of statement gaps identified for this account.
`lastRefreshAt`	A timestamp indicating when the gap summary was most recently updated.

Gap (`gapSummary.gaps[]`)

Fields nested within each item of the gaps array.

Field Name	Description
`endDate`	The end date of this suspected gap.
`startDate`	The start date of this suspected gap.
`status`	A high-level categorization of this statement gap.
`statusDetail`	A more detailed description of the cause of this statement gap.

Expected Accounts

Field Name	Description
`createdAt`	The timestamp when the expected account was created.
`createdBy`	The user who created the expected account.
`customData`	-
`expectedAccountNumber`	The expected account number associated with the expected account.
`id`	A unique identifier for the expected account.
`lastModifiedAt`	The timestamp when the expected account was last modified.
`lastModifiedBy`	The user who last modified the expected account.
`normalizedExpectedAccountNumber`	The normalized expected account number associated with the expected account.
`providerId`	The provider ID associated with the expected account.
`providerName`	The name of the utility service provider.

Meters

Field Name	Description
`accounts`	An array of the accounts this meter belongs to. These accounts are searchable on `accountNumber` and `accountId`.
`bulbType`	Type or specification of light bulbs associated with the account, if applicable.
`correlationIds`	A list of correlationIds cascaded from all directly associated Credentials and Files.
`createdAt`	A timestamp indicating when the entity was created.
`createdBy`	User or system responsible for creating the entity.
`currentTariff`	-
`customData`	You can use these fields to specify additional metadata.
`earliestIntervalAt`	A timestamp of the earliest interval available for the meter.
`generalDescriptionAsPrinted`	A general description of the account or service as printed on the bill.
`id`	A unique identifier for the entity.
`isIntervalsDormant`	Indicates whether the meter is dormant based on interval job results and error codes.
`isIntervalsProductActive`	Indicates if intervals is activated for the meter.
`isIntervalsThirdPartyPortalMeter`	Indicates whether or not this meter is enrolled under an intervals third party portal.
`isLocationRecommendationIgnored`	Indicates whether or not location recommendation should be ignored.
`isStandalone`	Indicates a meter is not expected to relate to a site.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resource.
`latestIntervalAt`	A timestamp of the latest interval available for the meter
`latestIntervalsCheckedAt`	A timestamp of the most recent intervals check Arcadia attempted.
`latestStatementDate`	The date of the most recent statement.
`localTimezone`	For meters that have intervals available, the meter's local timezone. The value can be any TZ identifier from this this list.
`meterConstantMultiplier`	The multiplier used to convert meter readings to actual usage values for the account. The first conversion after the meter delta is calculated
`meterNumber`	A number assigned to the meter by the commodity provider.
`nextExpectedPostDate`	The expected date for the next statement to be posted for this account.
`normalizedMeterNumber`	The normalized version of the meter number (removing things like hyphens, underscores, and leading zeros).
`normalizedPointOfDeliveryNumber`	The normalized version of the Point of Delivery number (removing things like hyphens, underscores, and leading zeros).
`pipeType`	This field is only populated when the Service Type of the meter is water. This field describes the pipe type
`pointOfDeliveryNumber`	The point of delivery number in deregulated markets is an independent identifier for meter location and used by all utility companies.
`previousMeterConstantMultiplier`	The previous multiplier used to convert meter readings to actual usage values.
`previousMeterNumber`	The number assigned to the previous meter used.
`provider`	-
`serviceAddress`	-
`serviceType`	The type of service supported, such as electricity, water, or gas.
`serviceTypeClassification`	The classification for the service type depending on the comprehensiveness of data that can be returned.
`site`	A physical location or facility associated with the meter. This field should be used to specify the site ID.
`status`	Status of the resource.
`statusDetail`	Reason the resource has the current status.
`voidedAt`	A timestamp indicating when the entity was voided. This value resets to null if the entity is unvoided. See event history for additional context.
`amountDue`	The monetary amount that is required to be paid.
`amountDueAfterDueDate`	The total amount due for the account after the due date, excluding any late fees or penalties.
`amountDueBeforeDueDate`	The total amount due for the account before the due date, excluding any late fees or penalties.
`bulbQuantity`	Quantity of light bulbs associated with the account, if applicable.
`charges`	Details of charges applied, including amounts, currency, etc.
`contributionStatus`	- `CONTRIBUTING` - Indicates the charge amount is a contributing value to the total bill amount. - `NON_CONTRIBUTING` - Indicates the charge amount does not contribute to the total bill amount. This may be because it's a redundant sub-total, or due to proration.
`currencyCode`	The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.
`customerNumber`	The bill contains a unique identifier for the customer associated with the account. This is not the account number
`cycleNumber`	The code or ID for a meter reading schedule.
`deregulationStatus`	Indicates the deregulation status of the account, if relevant.
`disconnectDate`	The date on which the service for the account was disconnected.
`discountBeforeDueDate`	Any discounts applied to the account if the outstanding balance is paid before the due date.
`dueDate`	The due date for payment associated with the account.
`facilityName`	The name of the facility indicated on the bill.
`facilityNumber`	A unique identifier for the facility indicated on the bill. This is not the account number.
`gridPointLineLoss`	The amount of energy loss that occurs during transmission and distribution at the grid point associated with the account.
`invoiceNumber`	The unique identifier or number assigned to a specific invoice.
`lineLoss`	The observed amount of energy lost during transmission and distribution before reaching the meter associated with the account.
`mapNumber`	Like cycle number, the code or ID indicates a meter reading schedule.
`meterConversionMultiplier`	The multiplier used to convert the raw meter readings to actual usage values, typically to adjust for factors such as calibration or unit conversion.
`meterId`	A unique identifier for a meter.
`meterReadDate`	The date on which the meter reading was taken.
`newCharges`	Any new charges applied to the account since the last billing cycle or statement.
`nextReadDate`	The date scheduled for the next meter reading.
`normalizedPreviousMeterNumber`	The normalized version of the previous meter number (removing things like hyphens, underscores, and leading zeros).
`outstandingBalance`	The remaining balance yet to be paid for the account.
`periodEndDate`	The end date of the measuring period.
`periodStartDate`	The start date of the measuring period.
`powerFactor`	The observed ratio of real power to apparent power, often used to measure the efficiency of electricity usage.
`previousBalance`	The balance carried forward from the previous billing period.
`previousReadDate`	The date of the previous meter reading.
`rateOrTariffNameAsPrinted`	The name of the rate or tariff plan as printed on the bill.
`readTypeAsPrinted`	The type of meter reading as printed on the bill or statement.
`statementDate`	The date of the statement.
`statementId`	The unique identifier of a statement.
`tariff`	-
`totalCharges`	The sum of `chargeAmount` fields in `charges` items that have a `contributionStatus` of "CONTRIBUTING".
`totalUsage`	Calculated by summing `measuredUsage` fields in the `usages` items that have a `measurementType` of "general_consumption", `contributionStatus` of "CONTRIBUTING", and at least one `tariffRateComponent` where `tariffRateComponentType` is "total". If multiple usages meet all these criteria, only ones with a `usageUnit` of "kWh" are used.
`totalUsageUnit`	The `usageUnit` used in the `usages` items that were used to calculate `totalUsage`.
`usages`	Details of usage data.
`electricServiceIdentifier`	The Electric Service Identifier (ESI ID) associated with the address for the meter. This field will be ignored when updating meters that are not associated with an intervals third party portal.
`retailCustomerEmail`	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. This field will be ignored when updating meters that are not associated with an intervals third party portal.

Statements

Field Name	Description
`accountData`	Data related to individual accounts, including billing information, usage history, etc.
`amountDue`	The monetary amount that is required to be paid.
`correlationIds`	A list of correlationIds cascaded from all directly associated Credentials and Files.
`createdAt`	A timestamp indicating when the entity was created.
`currencyCode`	The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.
`dataIngestionMethod`	Identifies the data ingestion method that created this Statement.
`discoveredAt`	Timestamp indicating when the statement data was discovered and added to the system.
`discoveredStatementId`	The unique identifier for the discovered statement in the Arcadia platform.
`dueDate`	The due date for payment associated with the account.
`id`	A unique identifier for the entity.
`invoiceNumber`	The unique identifier or number assigned to a specific invoice.
`isLatestVersion`	Indicates whether the Statement is the most recent versionId of the Statement.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`normalizedSummaryAccountNumber`	The normalized version of the Summary account number (removing things like hyphens, underscores, and leading zeros).
`outstandingBalance`	The remaining balance yet to be paid for the account.
`periodEndDate`	The end date of the measuring period.
`periodStartDate`	The start date of the measuring period.
`provider`	-
`statementDate`	The date of the statement.
`summaryAccountNumber`	The number or identifier assigned to the summary account by the provider.
`totalCharges`	The total charges applied for a specific billing period.
`type`	Describes the source document.
`versionId`	A unique identifier for the version of the statement entity at a given moment in time.
`amountDueAfterDueDate`	The total amount due for the account after the due date, excluding any late fees or penalties.
`amountDueBeforeDueDate`	The total amount due for the account before the due date, excluding any late fees or penalties.
`charges`	Details of charges applied, including amounts, currency, etc.
`credentialIds`	An unique identifier for a credential.
`customerNumber`	The bill contains a unique identifier for the customer associated with the account. This is not the account number
`cycleNumber`	The code or ID for a meter reading schedule.
`disconnectDate`	The date on which the service for the account was disconnected.
`discountBeforeDueDate`	Any discounts applied to the account if the outstanding balance is paid before the due date.
`isFinalBill`	Indicates whether the current bill is the final bill for the account.
`newCharges`	Any new charges applied to the account since the last billing cycle or statement.
`previousBalance`	The balance carried forward from the previous billing period.
`previousStatementDate`	The date of the previous bill.
`sourceType`	The data format of the data extraction source we used.
`summaryAccountId`	The unique identifier of the summary account.

Discovered Statements

Field Name	Description
`accountIds`	List of account IDs associated with the discovered statement.
`accountNumbers`	An array of account identifiers provided by the commodity provider (often times the bill publisher).
`correlationIds`	A list of correlationIds cascaded from all directly associated Credentials and Files.
`createdAt`	A timestamp indicating when the entity was created.
`credentialIds`	List of credential IDs associated with the discovered statement.
`dataIngestionMethod`	Identifies the data ingestion method that created this Statement.
`dueDate`	The due date for payment associated with the account.
`id`	A unique identifier for the entity.
`invoiceNumber`	The unique identifier or number assigned to a specific invoice.
`isLatestVersion`	Indicates whether the Statement is the most recent versionId of the Statement.
`periodEndDate`	The end date of the measuring period.
`periodStartDate`	The start date of the measuring period.
`provider`	-
`sourceType`	The format of the data extraction source we used.
`statementDate`	The date of the discovered statement.
`statementId`	The unique identifier of a statement.
`statementType`	Describes the source document.
`status`	Status of the discovered statement.
`versionId`	A unique identifier for the version of the Discovered Statement entity at a given moment in time.

Files

Field Name	Description
`accountNumbers`	An array of account identifiers provided by the commodity provider (often times the bill publisher).
`correlationId`	A string value you can set to help you reconcile with your internal systems.
`createdAt`	A timestamp indicating when the entity was created.
`createdBy`	User or system responsible for creating the entity.
`discoveredStatementId`	The unique identifier for the discovered statement in the Arcadia platform.
`fileName`	The name of the file when it was originally submitted.
`id`	A unique identifier for the entity.
`isCustomerActionRequired`	Indicates whether any action is required from you regarding this resource.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`provider`	-
`statementDate`	The date of the statement.
`statementId`	The unique identifier of a statement.
`status`	Status of the resource.
`statusDetails`	Reasons the resource has the current status.
`transferMethod`	Indicates the method you used to send data to us.

Charges

Field Name	Description
`additionalRateMultiplier`	This field represents an additional multiplier applied to rates, possibly for specific services or circumstances.
`averageUnitCostAsPrinted`	Average cost per unit (e.g., per kWh, per gallon) of energy or water usage as printed on the bill.
`chargeAmount`	The amount of the charge.
`chargeAmountCurrency`	The name of the currency of the charge amount.
`chargeCurrencyCode`	The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.
`chargeGroupHeading`	Additional charge description as seen on the bill.
`chargeNameAsPrinted`	The name of the charge as printed on the bill.
`chargeRate`	The rate applied for a specific charge, such as a usage charge or service fee.
`chargeRateAdder`	Additional rate added to the base charge rate, if applicable.
`chargeRateBase`	Base rate used for calculating charges.
`chargeRateCurrency`	The name of the currency of the charge rate (e.g. currency_dollars, currency_cents, currency_euros, etc).
`chargeType`	Type of the charge applied to the account.
`chargeUnitsUsed`	Unit of measure for any variable charges, where declared (not calculated).
`contributionStatus`	- `CONTRIBUTING` - Indicates the charge amount is a contributing value to the total bill amount. - `NON_CONTRIBUTING` - Indicates the charge amount does not contribute to the total bill amount. This may be because it's a redundant sub-total, or due to proration.
`createdAt`	A timestamp indicating when the entity was created.
`id`	A unique identifier for the entity.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lifecycleStage`	Lifecycle section for a specific charge. Values can be: `lifecycle_bundled`, `lifecycle_generation`, `lifecycle_transmission`, `lifecycle_distribution`, `lifecycle_combined_delivery`, `lifecycle_combined_supply`, `null`.
`measurementType`	Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries
`periodEndDate`	The end date of the measuring period.
`periodStartDate`	The start date of the measuring period.
`prorationStatus`	- `PRORATED` - Indicates this charge is the result of a proration calculation; for example, prorating an account level charge down to individual meters. - `PRORATION_SOURCE` - Indicates this charge was an original charge extracted from the bill, but we performed proration calculations on it to push it down in the statement graph. - `null` - Indicates this charge has no participation in a proration calculation.
`tariff`	-
`tariffRateComponents`	The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes.
`unitsPerRate`	When a rate is assessed on unit number greater than one.
`usageUnit`	The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons.

Usages

Field Name	Description
`calorificValue`	The calorific value associated with the energy source, if applicable (e.g., for natural gas).
`citedUsage`	This usage is not measured by a meter reading on the current statement. This is the billed usage.
`contributionStatus`	- `CONTRIBUTING` - Indicates the charge amount is a contributing value to the total bill amount. - `NON_CONTRIBUTING` - Indicates the charge amount does not contribute to the total bill amount. This may be because it's a redundant sub-total, or due to proration.
`createdAt`	A timestamp indicating when the entity was created.
`hoursOfUse`	The total number of hours the account or service has been used within a specific period.
`id`	A unique identifier for the entity.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`loadFactor`	The observed ratio of average demand to peak demand for the account, indicating the efficiency of energy usage.
`loadType`	The type of load associated with the account.
`measuredUsage`	Represents actual consumption at the meter for the account within a specific period.
`measurementType`	Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries
`meterConstantMultiplier`	The multiplier used to convert meter readings to actual usage values for the account. The first conversion after the meter delta is calculated
`meterConversionMultiplier`	The multiplier used to convert the raw meter readings to actual usage values, typically to adjust for factors such as calibration or unit conversion.
`meterReadDate`	The date on which the meter reading was taken.
`meterReadType`	The meter’s most recent read date in the statement. This field can be actual or estimated.
`meterReadingDelta`	The difference between the current meter reading and the previous meter reading, representing the usage during a specific period.
`meterReadingDeltaPrevious`	The previous difference between meter readings of consecutive periods.
`meterReadingDeltaUsageUnit`	The unit of measure used for expressing the meter reading delta (e.g., kWh, gallons).
`meterReadingRaw`	The raw meter reading value before any adjustments or conversions.
`meterReadingRawPrevious`	The previous raw meter reading value before any adjustments or conversions.
`numberOfDaysInPeriod`	The total number of days in the billing period or reporting period.
`outageBlock`	Published outage schedule by the provider.
`periodEndDate`	The end date of the measuring period.
`periodStartDate`	The start date of the measuring period.
`powerFactor`	The observed ratio of real power to apparent power, often used to measure the efficiency of electricity usage.
`pressureMultiplier`	This field is only populated when the Service Type for the meter is natural gas. It is an additional multiplier to measure units used.
`prevReadDate`	The date of the previous meter reading.
`previousMeterReadType`	The type or method of meter reading used for the previous meter.
`previousReadTypeAsPrinted`	The type of previous meter reading as printed on the bill.
`previousUsage`	The previous usage of the commodity within a specific period.
`prorationStatus`	- `PRORATED` - Indicates this usage is the result of a proration calculation; for example, prorating an account level usage down to individual meters. - `PRORATION_SOURCE` - Indicates this usage was an original usage extracted from the bill, but we performed proration calculations on it to push it down in the statement graph. - `INFERRED` - This status indicates a usage value was calculated from multiple other usages. Generally, this would happen if a bill provides usage sub-totals (e.g. for `off_peak`, `on_peak`, etc.) but no total. We would calculate an additional usage record representing the full total. - `null` - Indicates this usage has no participation in a proration calculation.
`rateOrTariffNameAsPrinted`	The name of the rate or tariff plan as printed on the bill.
`readTypeAsPrinted`	The type of meter reading as printed on the bill or statement.
`readingSchedule`	The frequency of meter readings.
`tariffRateComponents`	The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes.
`usageNameAsPrinted`	The name or label assigned to usage data as printed on the bill.
`usageUnit`	The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons.

Service Type

Field Name	Description
`serviceType`	The type of service supported, such as electricity, water, or gas.
`serviceTypeClassification`	The classification for the service type depending on the comprehensiveness of data that can be returned.

Tariff

The tariff the meter is currently on. Nested on Meter.tariff, Meter.currentTariff, and Charge.tariff.

Field Name	Description
`provider`	-
`tariffName`	The name of the tariff.

Tariff Rate Component

Nested within the tariffRateComponents array on Charges and Usage items.

Field Name	Description
`tariffName`	The name of the tariff.
`tariffRateComponentType`	A way to establish the purpose/classification of a charge with respect to the rate plan.

Provider

The entity providing service and issuing bills (informally known as a utility). The provider object is returned on its own endpoints and nested on resources like Statements, Meters, and Discovered Statements.

Field Name	Description
`country`	The country associated with the billing address.
`id`	A unique identifier for the entity.
`intervalServiceTypes`	List of interval service types supported by this provider (e.g., ['electric', 'gas'])
`isIntervalDataSupported`	Indicates whether the provider supports interval data
`isIntervalFileUploadSupported`	Indicates whether the provider supports interval file upload
`isRealTimeCredentialValidationSupported`	Indicates whether the provider supports credential validation
`name`	The name of the utility service provider.

Deletion

Field Name	Description
`accountCount`	The number of accounts. Note: if this is 0, but the entity being deleted has associated accounts, those accounts will be unlinked from the deleted entity but remain in the system. This is because the accounts are associated with another file or credential that is not being deleted.
`createdAt`	A timestamp indicating when the entity was created.
`createdBy`	User or system responsible for creating the entity.
`deletionTargetId`	The ID of the primary resource being deleted. May belong to an Account, Credential, File or Site.
`fileCount`	The total number of files that are requested to be deleted.
`id`	A unique identifier for the entity.
`meterCount`	The total number of meters associated with the account.
`siteCount`	The total number of Sites.
`statementCount`	The total number of statements.
`status`	Status of the resource.

Downloads

Download Request Object

The download request object returned when a download is created or queried.

Field Name	Description
`createdAt`	A timestamp indicating when the entity was created.
`downloadMethod`	Method used for downloading data.
`id`	A unique identifier for the entity.
`status`	Status of the resource.
`token`	We require this token to be provided when you want to access the requested download file. If you made the request via an API call, this token can be found in our response to you. If you made the request via the Dashboard, this token already be included in the email we would send you.

Download Request Body Fields

Fields accepted on the various download request bodies. Not every request body supports every field - see each endpoint's request body in the API reference for specifics.

Field Name	Description	Used By
`accountIds`	An array of `accountId`s from which you wish to download statements.	Account statements download endpoint.
`downloadMethod`	The method used to download the data.	All download request bodies
`endDate`	The end date of the billing period.	Account statements, Meter usage, Sites usage, Statement accounts download endpoints.
`globalSearch`	A global search string to filter across multiple fields.	Account statements, CSV download endpoints.
`search`	A search string to filter the accounts.	Account statements, CSV download endpoints.
`startDate`	The date indicating the start of a billing cycle or service period.	Account statements, Meter usage, Sites usage, Statement accounts download endpoints.
`columns`	-	CSV download endpoint.
`entityType`	-	CSV download endpoint.
`endAt`	The end date of the billing period.	Intervals download endpoint.
`ids`	An array of unique identifiers for multiple meters/sites.	Intervals download endpoint.
`intervalFormat`	The format in which output data is provided. Default : RAW	Intervals download endpoint.
`intervalTimeZone`	The timezone for the intervals. Default : METER	Intervals download endpoint.
`startAt`	The date indicating the start of a billing cycle or service period.	Intervals download endpoint.
`meterIds`	An array of unique identifiers for multiple meters.	Meter usage download endpoint.
`outputFormat`	The format in which output data is provided.	Meter usage, Sites usage download endpoints.
`siteIds`	An array of unique identifiers for multiple Sites.	Sites usage download endpoint.
`statementIds`	An array of unique identifiers for statements.	Statement accounts download endpoint.

Webhooks

Webhook Object

Describes a webhook delivery record that you can fetch through the API.

Field Name	Description
`createdAt`	A timestamp indicating when the entity was created.
`eventType`	The type of webhook. This field indicates the reason the webhook was emitted.
`id`	A unique identifier for the entity.
`lastAttemptedSendAt`	The timestamp indicating when we last attempted to send this webhook to you.
`lastSendHttpStatus`	The HTTP status code received for the most recent attempt to send this webhook.
`message`	The body payload of the webhook as a JSON string.
`nextScheduledSendAt`	The scheduled time for the next webhook to be sent.
`numberOfAttempts`	The number of attempts we have made to send this webhook.
`resource`	The resource type of the entity that the webhook references. This field determines the structure of the payload contained in the data field of the webhook body.
`status`	Status of the resource.
`webhookUrl`	The URL in Live mode used for you to receive webhook notifications or callbacks.

Sites

Field Name	Description
`addressIssueType`	Issue type of a site's address.
`area`	The area of the Site in square feet.
`buildingType`	The type of building.
`buildingTypeGroup`	The group of building types.
`createdAt`	A timestamp indicating when the entity was created.
`createdBy`	User or system responsible for creating the entity.
`facilityType`	Custom field for you to input site’s facility type. Deprecated in favor of buildingType.
`heatingFuel`	The type of heating fuel used in the Site.
`hvacCoolType`	The type of cooling system in the Site.
`hvacHeatType`	The type of heating system in the Site.
`hvacVentType`	The type of ventilation system in the Site.
`id`	A unique identifier for the entity.
`isLocationRecommendationIgnored`	Indicates if a site has been opted out of address verification.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resource.
`meterIds`	An array of unique identifiers for multiple meters.
`numberOfStories`	The number of stories of the Site.
`region`	The region or geographic area associated with the Site.
`serviceAddress`	-
`siteCode`	A code or identifier assigned to a specific site.
`siteName`	The name or label assigned to a specific Site.
`siteNumber`	The number or identifier assigned to a specific Site.
`subRegion`	A subregion or subdivision within a larger region, such as a county or district.
`yearBuilt`	The year the Site was built.

Events

Fields exposed on the various /events endpoints (Credential, Account, Meter, Site, etc.).

Field Name	Description
`createdAt`	The date-time this event occurred.
`createdBy`	The user or system that initiated the event.
`eventType`	The type of event that occurred.
`fieldName`	For field value changes, represents which field was modified.
`id`	A unique identifier for the event.
`newValue`	For field value changes, represents the newly assigned value of the field.
`oldValue`	For field value changes, represents the previous value of the field.

Intervals

Intervals endpoints return either the raw format or the normalized format, depending on the intervalFormat requested.

Common Fields (raw and normalized)

Field Name	Description
`correlationIds`	A list of correlationIds cascaded from all directly associated Credentials.
`credentialIds`	Arcadia generated unique identifier of the credential the meter belongs to.
`earliestIntervalAt`	Timestamp of the earliest interval available for the meter.
`electricMeterMultiplier`	Multiplier for electric meter (not relevant for non-electric service types).
`intervalsCreatedAt`	Timestamp when intervals were first created for the meter.
`intervalsUpdatedAt`	Timestamp when intervals were last updated for the meter.
`isIntervalsDormant`	Indicates whether the meter is dormant based on interval job results and error codes.
`latestIntervalAt`	Timestamp of the latest interval available for the meter.
`localTimezone`	Local timezone of the meter. The value can be any TZ identifier from this list.
`meterId`	Arcadia generated unique identifier of the meter
`meterNumber`	A number assigned to the meter by the commodity provider.
`providerId`	Arcadia generated unique identifier of the utility service provider.
`providerName`	The name of the utility service provider.
`readType`	Type of reading (actual, estimated, etc.)
`readings`	List of individual interval readings for this meter.
`serviceType`	The type of service supported, such as electricity, water, or gas.

Raw Intervals

In the raw format, readings is an array of reading objects.

`readings[]` item

Field Name	Description
`datapoints`	List of measurement values in different units
`direction`	Direction of energy flow (import, export, net)
`endAt`	End time of this interval
`kw`	Power usage in kW (deprecated)
`kwh`	Energy usage in kWh (deprecated)
`startAt`	Start time of this interval

`datapoints[]` item

Field Name	Description
`units`	Units of measurement for the value (e.g., kwh, kw, therms, ccf)
`value`	The measured value in the specified units

Normalized Intervals

Additional top-level fields on the normalized shape:

Field Name	Description
`endAt`	start time of last record in API response.
`intervalDurationMinutes`	Interval duration timestamp length in API response.
`sourceIntervalDurationMinutes`	Interval duration timestamp length as collected from utility.
`startAt`	start time of first record in API response.

In normalized format, readings is a single object (not an array).

`readings`

All energy fields below are arrays of numbers aligned positionally with the reading window.

Field Name	Description
`ccf`	Gas usage in cubic feet (ccf).
`electricMeterMultiplier`	Power factor of energy usage.
`exportKwh`	Energy exported by meter(in kwh).
`importKwh`	Energy imported by meter(in kwh).
`imputedReadingsPositions`	-
`netKwh`	Net energy usage of meter(in kwh).
`therms`	Gas usage in therms.

Organization and Users

Field Name	Description
`id`	A unique identifier for the entity.
`name`	The name for the resource.
`defaultWebhookUrl`	The webhook URL used for any events in Live mode. The default webhook URL we will use.
`displayName`	Name to be shown for this organization in the Arcadia Connect UI.
`privacyPolicy`	A URL for your company's privacy policy. This will be linked in the Arcadia Connect UI.
`sandboxWebhookUrl`	The URL for testing and reciving webhooks in sandbox mode.
`termsOfService`	A URL for your company's terms of service. This will be linked in the Arcadia Connect UI.
`email`	The email address associated with the account.
`roles`	The roles a user has.
`isEnabled`	-
`password`	The password associated with the account
`token`	We require this token to be provided when you want to update the password. If you made the password reset request via an API call, this token can be found in our response to you. If you made the password reset request via the Dashboard, this token already be included in the email we would send you.