Authentication

Field Name	Description
`access_token`	The access token that can be used to access the Arc 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.
`files`	An array of file objects representing what you submitted to Arcadia.

Credentials

Field Name	Description
`id`	A unique identifier for the entity.
`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.
`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.
`statements`	An array of statement objects.
`accountEvents`	Events associated with the account, such as when the value of a field changes etc.
`accounts`	An array of the accounts that satisfied the search criteria
`credentialEvents`	Events associated with the credential, such as when the value of a field changes etc.
`credentials`	Sensitive information used to authenticate with a utility provider in order to log into an utility account online.
`page`	Page number in the index of object returned.
`meterEvents`	Events associated with the meter, such as when the value of a field changes etc.
`meters`	An array of meters.
`payments`	Details of payments made for the account, including amounts, dates, etc.
`siteEvents`	Events associated with the site, such as when the value of a field changes etc.
`sites`	An array of Sites objects.
`details`	A map of additional details about the error.
`message`	Human readable text that elaborates on the error.
`type`	The type of error based on Arcadia's classification for errors.
`errors`	Contains an array of error objects.
`correlationId`	A string value you can set to help you reconcile with your internal systems. Correlation ID does not have to be unique.
`isInteractive`	Indicates whether the account supports interactive features or functionalities. 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.
`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.
`isActive`	Indicates whether the Credential is active for applicable products.
`createdAt`	The date-time this event occurred
`createdBy`	The user or system that initiated the event.
`eventType`	Describes the change that has been made to an account.
`fieldName`	For custom data changes, represents which custom data field was modified.
`newValue`	For custom data changes, represents the newly assigned value of the field.
`oldValue`	For custom data changes, represents the previous value of the field.
`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 resoruce.
`nextScheduledAccountRunAt`	The scheduled time for the next automated credential job.
`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.
`updateUrl`	The Connect URL used for updating or modifying credentials.

Account

Field Name	Description
`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.
`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.
`accountNumber`	An account identifier provided by the commodity provider (often times the bill publisher).
`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`	Address the bill is registered under.
`charges`	Details of charges applied, including amounts, currency, etc.
`customerNumber`	The bill contains a unique identifier for the customer associated with the account. This is not the account number and is seldom populated.
`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.
`normalizedAccountNumber`	The normalized version of the account number (removing things like hyphens, underscores, and leading zeros).
`outstandingBalance`	The remaining balance yet to be paid for the account.
`paymentAddress`	No description
`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.
`provider`	No description
`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.
`accountNumber`	An account identifier provided by the commodity provider (often times the bill publisher).
`meterData`	meterData: Data related to individual meters, including meter readings, usage history, etc.
`normalizedAccountNumber`	The normalized version of the account number (removing things like hyphens, underscores, and leading zeros).
`fieldName`	For custom data changes, represents which custom data field was modified.
`eventType`	The type of event that occurred. This field is searchable.
`newValue`	For custom data changes, represents the newly assigned value of the field.
`oldValue`	For custom data changes, represents the previous value of the field.
`createdAt`	A timestamp indicating when the entity account was created.
`createdBy`	User or system responsible for creating the entity.
`firstExtractedAt`	The timestamp for when data was first extracted for the account.
`id`	A unique identifier for the entity.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resoruce.
`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.
`prepaid`	Indicates whether the account operates on a prepaid basis, where services are paid for in advance.
`providerClassification`	Indicates whether this account is associated with the publisher or pass-through provider on the bill. `PUBLISHER`, `PASS_THROUGH`
`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. Possible values are `NORMAL`, `SUMMARY`, `SUB_ACCOUNT`.
`addressType`	Enumeration of strings field that indicates the comprehensiveness of the address for an account. Possible values are: `FULL`, `PARTIAL`, `CUSTOMER_PREFERRED`.
`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.
`correlationId`	A string value you can set to help you reconcile with your internal systems. Correlation ID does not have to be unique.
`isActive`	Indicates whether the Credential is active for applicable products.
`providerId`	The unique identifier of the utility service provider.
`customData`	You can use these fields to specify additional metadata.
`isStatementsProductActive`	Indicates whether the Plug Statements product is active for this account.
`amount`	The monetary amount associated with a specific transaction or charge.
`currency`	Currency of the amount.
`paymentDate`	The date on which payment was made for the account.
`name`	The name of the utility service provider.
`supportsCredentialValidation`	Indicates whether the provider supports credential validation

Meters

Field Name	Description
`accounts`	An array of the accounts this meter belongs to. These accounts are searchable on `accountNumber` and `accountId`.
`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.
`bulbType`	Type or specification of light bulbs associated with the account, if applicable.
`charges`	Details of charges applied, including amounts, currentcy, 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."
`createdAt`	A timestamp indicating when the entity account was created.
`createdBy`	User or system responsible for creating the entity.
`customData`	You can use these fields to specify additional metadata.
`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.
`eventType`	The type of event that occurred.
`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.
`fieldName`	For custom data changes, represents which custom data field was modified.
`generalDescriptionAsPrinted`	A general description of the account or service as printed on the bill.
`gridPointLineLoss`	The amount of energy loss that occurs during transmission and distribution at the grid point associated with the account.
`id`	A unique identifier for the entity.
`invoiceNumber`	The unique identifier or number assigned to a specific invoice.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resoruce.
`latestStatementDate`	The date of the most recent statement.
`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.
`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.
`meterId`	A unique identifier for a meter.
`meterNumber`	A number assigned to the meter by the commodity provider.
`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.
`newValue`	For custom data changes, represents the newly assigned value of the field.
`nextExpectedPostDate`	The expected date for the next statement to be posted for this account.
`nextReadDate`	The date scheduled for the next meter reading.
`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).
`normalizedPreviousMeterNumber`	The normalized version of the previous meter number (removing things like hyphens, underscores, and leading zeros).
`oldValue`	For custom data changes, represents the previous value of the field.
`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.
`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.
`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.
`previousMeterConstantMultiplier`	The previous multiplier used to convert meter readings to actual usage values.
`previousMeterNumber`	The number assigned to the previous meter used when printed on the statement.
`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.
`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 account.
`statementDate`	The date of the statement.
`statementId`	The unique identifier of a statement.
`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.

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.
`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.
`createdAt`	A timestamp indicating when the entity account was created.
`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.
`dataIngestionMethod`	Indicates the method you used to send data to us.
`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.
`discoveredAt`	Timestamp indicating when the account data was discovered and added to the system.
`dueDate`	The due date for payment associated with the account.
`id`	No description
`invoiceNumber`	The unique identifier or number assigned to a specific invoice.
`isFinalBill`	No description
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`newCharges`	Any new charges applied to the account since the last billing cycle or statement.
`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.
`previousBalance`	The balance carried forward from the previous billing period.
`previousStatementDate`	The date of the previous bill.
`provider`	No description
`sourceType`	The data format of the data extraction source we used.
`statementDate`	The date of the statement.
`summaryAccountId`	The unique identifier of the summary account.
`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. Options are `BILL`, `NOTICE`, `ADJUSTMENT`, and `PREPAID`.
`usages`	Details of usage data.

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. Correlation ID does not have to be unique.
`createdAt`	A timestamp indicating when the entity account was created.
`createdBy`	User or system responsible for creating the entity.
`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.
`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.
`chargeAmountCurrency`	The name of the currency of the charge amount.
`chargeCurrencyCode`	The three-digit ISO currency code representing the currency of the charge (e.g., USD, EUR).
`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`	Currency code for the charge rate (e.g., USD, EUR).
`chargeType`	Type of the charge applied to the account (Debit or Credit).
`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 account was created.
`lifecycleStage`	Lifecycle section for a specific charge. Values can be: `BUNDLED`, `GENERATION`, `TRANSMISSION`, `DISTRIBUTION`, `COMBINED_DELIVERY`.
`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.
`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.

Usage

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 account 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 acutal 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 natrual 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 compodity 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

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

Field Name	Description
`page`	No description
`providers`	An array of unique identifiers of the utility service provider
`fieldLabel`	This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the label you should use for the input field.
`fieldLength`	This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the length of the input field. You can use this to build input validations.
`fieldName`	This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the name that corresponds to the field you would use when submitting a credential to the API (e.g. username, username2, etc.).
`fieldNumber`	This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is for indicating the order that login inputs appear on the page.
`fieldPart`	This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is for handling input fields when they are are split by dashes or other symbols, indicating with part this input corresponds to.
`country`	The country associated with the billing address.
`id`	A unique identifier for the entity.
`isHistorySupported`	Indicates whether the provider supports historical data at the account level.
`isMultiFactorAuthenticationSupported`	This field indicates whether Arcadia is able to support MFA for the provider. It does not indicate whether the provider requires MFA.
`isRealTimeCredentialValidationSupported`	Indicates whether the provider supports Real-Time Credential Validation.
`isThirdPartyPortalSupported`	Indicates whether the provider supports integration with third-party portals or platforms.
`name`	The name of the utility service provider.
`requiredFieldMetadata`	Detailed information about the required input fields for this provider.
`requiredFields`	The inputs needed to submit a request for this provider.
`serviceTypes`	An array of all type of service supported, such as electricity, water, or gas.
`website`	The website for the provider.

Deletion

Field Name	Description
`accountCount`	The number of accounts.
`createdAt`	A timestamp indicating when the entity account 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

Field Name	Description
`accountIds`	An array of `accountId`s from which you wish to download statements.
`createdAt`	A timestamp indicating when the entity account was created.
`downloadMethod`	Method used for downloading data.
`endDate`	The end date of the billing period.
`id`	A unique identifier for the entity.
`meterIds`	An array of unique identifiers for multiple meters.
`outputFormat`	The format in which output data is provided.
`siteIds`	An array of unique identifiers for multiple Sites.
`startDate`	The date indicating the start of a billing cycle or service period.
`statementIds`	An array of unique identifiers for statements.
`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.

Webhooks

Field Name	Description
`createdAt`	A timestamp indicating when the entity account was created.
`eventType`	The type of webhook. This field indicates the reason the webhook was emitted.
`id`	The id of the webhook itself, not the resource that the webhook references.
`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.
`webhooks`	An array of webhook objects.
`webhookUrl`	The URL in Live mode used for you to receive webhook notifications or callbacks.

Custom Data

Field Name	Description
`accountCustomData1Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData2Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData3Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData4Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData5Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData6Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData7Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData8Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData9Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`accountCustomData10Name`	Custom data fields associated with each account, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`id`	A unique identifier for the entity.
`meterCustomData1Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData2Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData3Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData4Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData5Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData6Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData7Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData8Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData9Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`meterCustomData10Name`	Custom data fields associated with each meter, allowing for additional metadata or information to be stored. There can be up to 10 different custom data fields for an account.
`name`	The name for the resource.

Organization and Users

Field Name	Description
`activeProducts`	Active products of this organization
`createdAt`	A timestamp indicating when the entity account was created.
`createdBy`	User or system responsible for creating the entity.
`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.
`email`	The email address associated with the account.
`id`	A unique identifier for the entity.
`lastModifiedAt`	The timestamp indicating when this resource was last modified.
`lastModifiedBy`	The user or system that last modified this resource.
`lastSuccessfulLoginAt`	The timestamp indicating the most recent successful login attempt.
`name`	Name of this organization
`page`	No description
`password`	The password associated with the account
`passwordModifiedAt`	The timestamp indicating when the account password was last modified.
`privacyPolicy`	A URL for your company's privacy policy. This will be linked in the Arcadia Connect UI.
`roles`	The roles a user has.
`sandboxWebhookUrl`	The URL for testing and receiving webhooks in sandbox mode.
`termsOfService`	A URL for your company's terms of service. This will be linked in the Arcadia Connect UI.
`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.
`uniqueId`	Unique ID for the organization used in Connect.
`users`	An array of user objects.