--- title: "List Detailed Statements" method: GET path: "/plug/statements/details" tags: ["Statements"] --- # List Detailed Statements `GET /plug/statements/details` Get a list of Detailed Statements in the Arcadia system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). ## Query parameters - `search` string - `globalSearch` string - `isCrossVersionSearch` boolean - `page` integer - `size` integer - `sort` string[] ## Headers - `Arcadia-Version` string, required ## Response `200` OK - PagedDetailedStatementResource - `page` PageMetadata, required — Specifies which page of results to return; this is 0-indexed - `number` integer, required - `size` integer, required - `totalElements` integer, required - `totalPages` integer, required - `statements` PublicDetailedStatementResource[], required — An array of statement objects. - `accountData` PublicAccountDataResource[], required — Data related to individual accounts, including billing information, usage history, etc. - `accountId` string, required — An unique identifier for an account. - `accountName1` string, nullable, required — 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` string, nullable, required — 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` string, required — An account identifier provided by the commodity provider (often times the bill publisher). - `amountDue` number, nullable, required — The monetary amount that is required to be paid. - `amountDueAfterDueDate` number, nullable, required — The total amount due for the account after the due date, excluding any late fees or penalties. - `amountDueBeforeDueDate` number, nullable, required — The total amount due for the account before the due date, excluding any late fees or penalties. - `billingAddress` PublicAddressResource, nullable, required — Address associated with the service location for the account. - `addressType` 'FULL' | 'PARTIAL' | 'CUSTOMER_PREFERRED', required — Enumeration of strings field that indicates the comprehensiveness of the address for an account. - `city` string, nullable, required — The city associated with the billing address. - `country` string, nullable, required — The country associated with the billing address. - `fullAddress` string, nullable, required — The complete address associated with the account, including street address, city, postal code, and country. - `postalCode` string, nullable, required — The postal code or ZIP code associated with the address of the account. - `recipient` string, nullable, required — The recipient for the address. - `state` string, nullable, required — The state or province associated with the billing address of the account. - `streetLine1` string, nullable, required — The first line of the street address. - `streetLine2` string, nullable, required — The second line of the street address. - `charges` PublicChargeResource[], required — Details of charges applied, including amounts, currency, etc. - `additionalRateMultiplier` number, nullable, required — This field represents an additional multiplier applied to rates, possibly for specific services or circumstances. - `averageUnitCostAsPrinted` number, nullable, required — Average cost per unit (e.g., per kWh, per gallon) of energy or water usage as printed on the bill. - `chargeAmount` number, nullable, required — The amount of the charge. - `chargeAmountCurrency` string, nullable, required — The name of the currency of the charge amount. - `chargeCurrencyCode` 'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS', nullable, required — The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time. - `chargeGroupHeading` string, nullable, required — Additional charge description as seen on the bill. - `chargeNameAsPrinted` string, nullable, required — The name of the charge as printed on the bill. - `chargeRate` number, nullable, required — The rate applied for a specific charge, such as a usage charge or service fee. - `chargeRateAdder` number, nullable, required — Additional rate added to the base charge rate, if applicable. - `chargeRateBase` number, nullable, required — Base rate used for calculating charges. - `chargeRateCurrency` string, nullable, required — The name of the currency of the charge rate (e.g. currency_dollars, currency_cents, currency_euros, etc). - `chargeType` 'DEBIT' | 'CREDIT', nullable, required — Type of the charge applied to the account. - `chargeUnitsUsed` number, nullable, required — Unit of measure for any variable charges, where declared (not calculated). - `contributionStatus` 'CONTRIBUTING' | 'NON_CONTRIBUTING', nullable, required — * `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` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `id` string, required — A unique identifier for the entity. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `lifecycleStage` string, nullable, required — 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` string, nullable, required — Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `prorationStatus` 'PRORATED' | 'PRORATION_SOURCE' | 'INFERRED', nullable, required — * `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` PublicTariffResource, nullable, required — The tariff the meter is currently on. - `provider` PublicProviderResource, nullable, required — The entity providing service and issuing bills (informally known as a utility). - `country` string, nullable, required — The country associated with the billing address. - `id` string, required — A unique identifier for the entity. - `intervalServiceTypes` string[], required — List of interval service types supported by this provider (e.g., ['electric', 'gas']) - `isIntervalDataSupported` boolean, nullable, required — Indicates whether the provider supports interval data - `isIntervalFileUploadSupported` boolean, nullable, required — Indicates whether the provider supports interval file upload - `isRealTimeCredentialValidationSupported` boolean, required — Indicates whether the provider supports credential validation - `name` string, nullable, required — The name of the utility service provider. - `tariffName` string, required — The name of the tariff. - `tariffRateComponents` PublicTariffRateComponentResource[], required — The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes. - `tariffName` string, required — The name of the tariff. - `tariffRateComponentType` string, required — A way to establish the purpose/classification of a charge with respect to the rate plan. - `unitsPerRate` number, nullable, required — When a rate is assessed on unit number greater than one. - `usageUnit` string, nullable, required — The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons. - `createdAt` string, date-time, required — A timestamp indicating when the entity was created. - `currencyCode` 'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS', nullable, required — The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time. - `customerNumber` string, nullable, required — The bill contains a unique identifier for the customer associated with the account. This is not the account number - `cycleNumber` string, nullable, required — The code or ID for a meter reading schedule. - `disconnectDate` string, date, nullable, required — The date on which the service for the account was disconnected. - `discountBeforeDueDate` number, nullable, required — Any discounts applied to the account if the outstanding balance is paid before the due date. - `dueDate` string, date, nullable, required — The due date for payment associated with the account. - `facilityName` string, nullable, required — The name of the facility indicated on the bill. - `facilityNumber` string, nullable, required — A unique identifier for the facility indicated on the bill. This is not the account number. - `installmentDue` number, nullable, required — The amount due for a specific installment payment associated with the account. - `installmentOutstanding` number, nullable, required — The amount outstanding or remaining to be paid for a specific installment. - `invoiceNumber` string, nullable, required — The unique identifier or number assigned to a specific invoice. - `mapNumber` string, nullable, required — Like cycle number, the code or ID indicates a meter reading schedule. - `meterData` PublicMeterDataResource[], required — meterData: Data related to individual meters, including meter readings, usage history, etc. - `amountDue` number, nullable, required — The monetary amount that is required to be paid. - `amountDueAfterDueDate` number, nullable, required — The total amount due for the account after the due date, excluding any late fees or penalties. - `amountDueBeforeDueDate` number, nullable, required — The total amount due for the account before the due date, excluding any late fees or penalties. - `bulbQuantity` number, nullable, required — Quantity of light bulbs associated with the account, if applicable. - `bulbType` string, nullable, required — Type or specification of light bulbs associated with the account, if applicable. - `charges` PublicChargeResource[], required — Details of charges applied, including amounts, currency, etc. - `additionalRateMultiplier` number, nullable, required — This field represents an additional multiplier applied to rates, possibly for specific services or circumstances. - `averageUnitCostAsPrinted` number, nullable, required — Average cost per unit (e.g., per kWh, per gallon) of energy or water usage as printed on the bill. - `chargeAmount` number, nullable, required — The amount of the charge. - `chargeAmountCurrency` string, nullable, required — The name of the currency of the charge amount. - `chargeCurrencyCode` 'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS', nullable, required — The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time. - `chargeGroupHeading` string, nullable, required — Additional charge description as seen on the bill. - `chargeNameAsPrinted` string, nullable, required — The name of the charge as printed on the bill. - `chargeRate` number, nullable, required — The rate applied for a specific charge, such as a usage charge or service fee. - `chargeRateAdder` number, nullable, required — Additional rate added to the base charge rate, if applicable. - `chargeRateBase` number, nullable, required — Base rate used for calculating charges. - `chargeRateCurrency` string, nullable, required — The name of the currency of the charge rate (e.g. currency_dollars, currency_cents, currency_euros, etc). - `chargeType` 'DEBIT' | 'CREDIT', nullable, required — Type of the charge applied to the account. - `chargeUnitsUsed` number, nullable, required — Unit of measure for any variable charges, where declared (not calculated). - `contributionStatus` 'CONTRIBUTING' | 'NON_CONTRIBUTING', nullable, required — * `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` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `id` string, required — A unique identifier for the entity. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `lifecycleStage` string, nullable, required — 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` string, nullable, required — Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `prorationStatus` 'PRORATED' | 'PRORATION_SOURCE' | 'INFERRED', nullable, required — * `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` PublicTariffResource, nullable, required — The tariff the meter is currently on. - `provider` PublicProviderResource, nullable, required — The entity providing service and issuing bills (informally known as a utility). - … - `tariffName` string, required — The name of the tariff. - `tariffRateComponents` PublicTariffRateComponentResource[], required — The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes. - `tariffName` string, required — The name of the tariff. - `tariffRateComponentType` string, required — A way to establish the purpose/classification of a charge with respect to the rate plan. - `unitsPerRate` number, nullable, required — When a rate is assessed on unit number greater than one. - `usageUnit` string, nullable, required — The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons. - `contributionStatus` 'CONTRIBUTING' | 'NON_CONTRIBUTING', nullable, required — "* `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` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `currencyCode` 'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS', nullable, required — The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time. - `customerNumber` string, nullable, required — The bill contains a unique identifier for the customer associated with the account. This is not the account number - `cycleNumber` string, nullable, required — The code or ID for a meter reading schedule. - `deregulationStatus` string, required — Indicates the deregulation status of the account, if relevant. - `disconnectDate` string, date, nullable, required — The date on which the service for the account was disconnected. - `discountBeforeDueDate` number, nullable, required — Any discounts applied to the account if the outstanding balance is paid before the due date. - `dueDate` string, date, nullable, required — The due date for payment associated with the account. - `facilityName` string, nullable, required — The name of the facility indicated on the bill. - `facilityNumber` string, nullable, required — A unique identifier for the facility indicated on the bill. This is not the account number. - `generalDescriptionAsPrinted` string, nullable, required — A general description of the account or service as printed on the bill. - `gridPointLineLoss` number, nullable, required — The amount of energy loss that occurs during transmission and distribution at the grid point associated with the account. - `invoiceNumber` string, nullable, required — The unique identifier or number assigned to a specific invoice. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `lineLoss` number, nullable, required — The observed amount of energy lost during transmission and distribution before reaching the meter associated with the account. - `mapNumber` string, nullable, required — Like cycle number, the code or ID indicates a meter reading schedule. - `meterConstantMultiplier` number, 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 - `meterConversionMultiplier` number, nullable, required — 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` string, required — A unique identifier for a meter. - `meterNumber` string, nullable, required — A number assigned to the meter by the commodity provider. - `meterReadDate` string, date, nullable, required — The date on which the meter reading was taken. - `newCharges` number, nullable, required — Any new charges applied to the account since the last billing cycle or statement. - `nextReadDate` string, date, nullable, required — The date scheduled for the next meter reading. - `normalizedMeterNumber` string, nullable, required — The normalized version of the meter number (removing things like hyphens, underscores, and leading zeros). - `normalizedPointOfDeliveryNumber` string, nullable, required — The normalized version of the Point of Delivery number (removing things like hyphens, underscores, and leading zeros). - `normalizedPreviousMeterNumber` string, nullable, required — The normalized version of the previous meter number (removing things like hyphens, underscores, and leading zeros). - `outstandingBalance` number, nullable, required — The remaining balance yet to be paid for the account. - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `pipeType` string, nullable, required — This field is only populated when the Service Type of the meter is water. This field describes the pipe type - `pointOfDeliveryNumber` string, nullable, required — The point of delivery number in deregulated markets is an independent identifier for meter location and used by all utility companies. - `powerFactor` number, nullable, required — The observed ratio of real power to apparent power, often used to measure the efficiency of electricity usage. - `previousBalance` number, nullable, required — The balance carried forward from the previous billing period. - `previousMeterConstantMultiplier` number, nullable, required — The previous multiplier used to convert meter readings to actual usage values. - `previousMeterNumber` string, nullable, required — The number assigned to the previous meter used. - `previousReadDate` string, date, nullable, required — The date of the previous meter reading. - `rateOrTariffNameAsPrinted` string, nullable, required — The name of the rate or tariff plan as printed on the bill. - `readTypeAsPrinted` string, nullable, required — The type of meter reading as printed on the bill or statement. - `serviceAddress` PublicAddressResource, nullable, required — Address associated with the service location for the account. - `addressType` 'FULL' | 'PARTIAL' | 'CUSTOMER_PREFERRED', required — Enumeration of strings field that indicates the comprehensiveness of the address for an account. - `city` string, nullable, required — The city associated with the billing address. - `country` string, nullable, required — The country associated with the billing address. - `fullAddress` string, nullable, required — The complete address associated with the account, including street address, city, postal code, and country. - `postalCode` string, nullable, required — The postal code or ZIP code associated with the address of the account. - `recipient` string, nullable, required — The recipient for the address. - `state` string, nullable, required — The state or province associated with the billing address of the account. - `streetLine1` string, nullable, required — The first line of the street address. - `streetLine2` string, nullable, required — The second line of the street address. - `serviceType` string, 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. - `statementDate` string, date, nullable, required — The date of the statement. - `statementId` string, nullable, required — The unique identifier of a statement. - `tariff` PublicTariffResource, nullable, required — The tariff the meter is currently on. - `provider` PublicProviderResource, nullable, required — The entity providing service and issuing bills (informally known as a utility). - `country` string, nullable, required — The country associated with the billing address. - `id` string, required — A unique identifier for the entity. - `intervalServiceTypes` string[], required — List of interval service types supported by this provider (e.g., ['electric', 'gas']) - `isIntervalDataSupported` boolean, nullable, required — Indicates whether the provider supports interval data - `isIntervalFileUploadSupported` boolean, nullable, required — Indicates whether the provider supports interval file upload - `isRealTimeCredentialValidationSupported` boolean, required — Indicates whether the provider supports credential validation - `name` string, nullable, required — The name of the utility service provider. - `tariffName` string, required — The name of the tariff. - `totalCharges` number, nullable, required — The sum of `chargeAmount` fields in `charges` items that have a `contributionStatus` of "CONTRIBUTING". - `totalUsage` number, nullable, required — 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` string, nullable, required — The `usageUnit` used in the `usages` items that were used to calculate `totalUsage`. - `usages` PublicUsageResource[], required — Details of usage data. - `calorificValue` number, nullable, required — The calorific value associated with the energy source, if applicable (e.g., for natural gas). - `citedUsage` number, nullable, required — This usage is not measured by a meter reading on the current statement. This is the billed usage. - `contributionStatus` 'CONTRIBUTING' | 'NON_CONTRIBUTING', nullable, required — * `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` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `hoursOfUse` number, nullable, required — The total number of hours the account or service has been used within a specific period. - `id` string, required — A unique identifier for the entity. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `loadFactor` number, nullable, required — The observed ratio of average demand to peak demand for the account, indicating the efficiency of energy usage. - `loadType` string, nullable, required — The type of load associated with the account. - `measuredUsage` number, nullable, required — Represents actual consumption at the meter for the account within a specific period. - `measurementType` string, nullable, required — Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries - `meterConstantMultiplier` number, 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 - `meterConversionMultiplier` number, nullable, required — 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` string, date, nullable, required — The date on which the meter reading was taken. - `meterReadType` string, nullable, required — The meter’s most recent read date in the statement. This field can be actual or estimated. - `meterReadingDelta` number, nullable, required — The difference between the current meter reading and the previous meter reading, representing the usage during a specific period. - `meterReadingDeltaPrevious` number, nullable, required — The previous difference between meter readings of consecutive periods. - `meterReadingDeltaUsageUnit` string, nullable, required — The unit of measure used for expressing the meter reading delta (e.g., kWh, gallons). - `meterReadingRaw` number, nullable, required — The raw meter reading value before any adjustments or conversions. - `meterReadingRawPrevious` number, nullable, required — The previous raw meter reading value before any adjustments or conversions. - `numberOfDaysInPeriod` number, nullable, required — The total number of days in the billing period or reporting period. - `outageBlock` string, nullable, required — Published outage schedule by the provider. - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `powerFactor` number, nullable, required — The observed ratio of real power to apparent power, often used to measure the efficiency of electricity usage. - `pressureMultiplier` number, nullable, required — 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` string, date, nullable, required — The date of the previous meter reading. - `previousMeterReadType` string, nullable, required — The type or method of meter reading used for the previous meter. - `previousReadTypeAsPrinted` string, nullable, required — The type of previous meter reading as printed on the bill. - `previousUsage` number, nullable, required — The previous usage of the commodity within a specific period. - `prorationStatus` 'PRORATED' | 'PRORATION_SOURCE' | 'INFERRED', nullable, required — * `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` string, nullable, required — The name of the rate or tariff plan as printed on the bill. - `readTypeAsPrinted` string, nullable, required — The type of meter reading as printed on the bill or statement. - `readingSchedule` string, nullable, required — The frequency of meter readings. - `tariffRateComponents` PublicTariffRateComponentResource[], required — The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes. - `tariffName` string, required — The name of the tariff. - `tariffRateComponentType` string, required — A way to establish the purpose/classification of a charge with respect to the rate plan. - `usageNameAsPrinted` string, nullable, required — The name or label assigned to usage data as printed on the bill. - `usageUnit` string, nullable, required — The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons. - `newCharges` number, nullable, required — Any new charges applied to the account since the last billing cycle or statement. - `normalizedAccountNumber` string, required — The normalized version of the account number (removing things like hyphens, underscores, and leading zeros). - `outstandingBalance` number, nullable, required — The remaining balance yet to be paid for the account. - `paymentAddress` PublicAddressResource, nullable, required — Address associated with the service location for the account. - `addressType` 'FULL' | 'PARTIAL' | 'CUSTOMER_PREFERRED', required — Enumeration of strings field that indicates the comprehensiveness of the address for an account. - `city` string, nullable, required — The city associated with the billing address. - `country` string, nullable, required — The country associated with the billing address. - `fullAddress` string, nullable, required — The complete address associated with the account, including street address, city, postal code, and country. - `postalCode` string, nullable, required — The postal code or ZIP code associated with the address of the account. - `recipient` string, nullable, required — The recipient for the address. - `state` string, nullable, required — The state or province associated with the billing address of the account. - `streetLine1` string, nullable, required — The first line of the street address. - `streetLine2` string, nullable, required — The second line of the street address. - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `previousBalance` number, nullable, required — The balance carried forward from the previous billing period. - `provider` PublicAccountDataProviderResource, required — This resource represents the provider for an account data entry on a statement. In the statement context, the publisher provider is the provider that posts the bill whereas the pass-through provider is one that is listed on the bill but does not post it. - `classification` 'PUBLISHER' | 'PASS_THROUGH', required — The classification of the provider. Useful to identify if this is a publisher or pass-through provider. - `id` string, required — The unique identifier for the provider in the Arcadia platform. - `name` string, required — The name of the provider. - `publisherProviderAccountId` string, required — 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. - `statementDate` string, date, nullable, required — The date of the statement. - `statementId` string, required — The unique identifier of a statement. - `totalCharges` number, nullable, required — The total charges applied for a specific billing period. - `usages` PublicUsageResource[], required — Details of usage data. - `calorificValue` number, nullable, required — The calorific value associated with the energy source, if applicable (e.g., for natural gas). - `citedUsage` number, nullable, required — This usage is not measured by a meter reading on the current statement. This is the billed usage. - `contributionStatus` 'CONTRIBUTING' | 'NON_CONTRIBUTING', nullable, required — * `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` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `hoursOfUse` number, nullable, required — The total number of hours the account or service has been used within a specific period. - `id` string, required — A unique identifier for the entity. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `loadFactor` number, nullable, required — The observed ratio of average demand to peak demand for the account, indicating the efficiency of energy usage. - `loadType` string, nullable, required — The type of load associated with the account. - `measuredUsage` number, nullable, required — Represents actual consumption at the meter for the account within a specific period. - `measurementType` string, nullable, required — Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries - `meterConstantMultiplier` number, 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 - `meterConversionMultiplier` number, nullable, required — 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` string, date, nullable, required — The date on which the meter reading was taken. - `meterReadType` string, nullable, required — The meter’s most recent read date in the statement. This field can be actual or estimated. - `meterReadingDelta` number, nullable, required — The difference between the current meter reading and the previous meter reading, representing the usage during a specific period. - `meterReadingDeltaPrevious` number, nullable, required — The previous difference between meter readings of consecutive periods. - `meterReadingDeltaUsageUnit` string, nullable, required — The unit of measure used for expressing the meter reading delta (e.g., kWh, gallons). - `meterReadingRaw` number, nullable, required — The raw meter reading value before any adjustments or conversions. - `meterReadingRawPrevious` number, nullable, required — The previous raw meter reading value before any adjustments or conversions. - `numberOfDaysInPeriod` number, nullable, required — The total number of days in the billing period or reporting period. - `outageBlock` string, nullable, required — Published outage schedule by the provider. - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `powerFactor` number, nullable, required — The observed ratio of real power to apparent power, often used to measure the efficiency of electricity usage. - `pressureMultiplier` number, nullable, required — 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` string, date, nullable, required — The date of the previous meter reading. - `previousMeterReadType` string, nullable, required — The type or method of meter reading used for the previous meter. - `previousReadTypeAsPrinted` string, nullable, required — The type of previous meter reading as printed on the bill. - `previousUsage` number, nullable, required — The previous usage of the commodity within a specific period. - `prorationStatus` 'PRORATED' | 'PRORATION_SOURCE' | 'INFERRED', nullable, required — * `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` string, nullable, required — The name of the rate or tariff plan as printed on the bill. - `readTypeAsPrinted` string, nullable, required — The type of meter reading as printed on the bill or statement. - `readingSchedule` string, nullable, required — The frequency of meter readings. - `tariffRateComponents` PublicTariffRateComponentResource[], required — The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes. - `tariffName` string, required — The name of the tariff. - `tariffRateComponentType` string, required — A way to establish the purpose/classification of a charge with respect to the rate plan. - `usageNameAsPrinted` string, nullable, required — The name or label assigned to usage data as printed on the bill. - `usageUnit` string, nullable, required — The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons. - `amountDue` number, nullable, required — The monetary amount that is required to be paid. - `amountDueAfterDueDate` number, nullable, required — The total amount due for the account after the due date, excluding any late fees or penalties. - `amountDueBeforeDueDate` number, nullable, required — The total amount due for the account before the due date, excluding any late fees or penalties. - `charges` PublicChargeResource[], required — Details of charges applied, including amounts, currency, etc. - `additionalRateMultiplier` number, nullable, required — This field represents an additional multiplier applied to rates, possibly for specific services or circumstances. - `averageUnitCostAsPrinted` number, nullable, required — Average cost per unit (e.g., per kWh, per gallon) of energy or water usage as printed on the bill. - `chargeAmount` number, nullable, required — The amount of the charge. - `chargeAmountCurrency` string, nullable, required — The name of the currency of the charge amount. - `chargeCurrencyCode` 'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS', nullable, required — The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time. - `chargeGroupHeading` string, nullable, required — Additional charge description as seen on the bill. - `chargeNameAsPrinted` string, nullable, required — The name of the charge as printed on the bill. - `chargeRate` number, nullable, required — The rate applied for a specific charge, such as a usage charge or service fee. - `chargeRateAdder` number, nullable, required — Additional rate added to the base charge rate, if applicable. - `chargeRateBase` number, nullable, required — Base rate used for calculating charges. - `chargeRateCurrency` string, nullable, required — The name of the currency of the charge rate (e.g. currency_dollars, currency_cents, currency_euros, etc). - `chargeType` 'DEBIT' | 'CREDIT', nullable, required — Type of the charge applied to the account. - `chargeUnitsUsed` number, nullable, required — Unit of measure for any variable charges, where declared (not calculated). - `contributionStatus` 'CONTRIBUTING' | 'NON_CONTRIBUTING', nullable, required — * `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` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `id` string, required — A unique identifier for the entity. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `lifecycleStage` string, nullable, required — 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` string, nullable, required — Delivery terms for the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `prorationStatus` 'PRORATED' | 'PRORATION_SOURCE' | 'INFERRED', nullable, required — * `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` PublicTariffResource, nullable, required — The tariff the meter is currently on. - `provider` PublicProviderResource, nullable, required — The entity providing service and issuing bills (informally known as a utility). - `country` string, nullable, required — The country associated with the billing address. - `id` string, required — A unique identifier for the entity. - `intervalServiceTypes` string[], required — List of interval service types supported by this provider (e.g., ['electric', 'gas']) - `isIntervalDataSupported` boolean, nullable, required — Indicates whether the provider supports interval data - `isIntervalFileUploadSupported` boolean, nullable, required — Indicates whether the provider supports interval file upload - `isRealTimeCredentialValidationSupported` boolean, required — Indicates whether the provider supports credential validation - `name` string, nullable, required — The name of the utility service provider. - `tariffName` string, required — The name of the tariff. - `tariffRateComponents` PublicTariffRateComponentResource[], required — The components or elements that make up the tariff rate, such as base charges, usage charges, and taxes. - `tariffName` string, required — The name of the tariff. - `tariffRateComponentType` string, required — A way to establish the purpose/classification of a charge with respect to the rate plan. - `unitsPerRate` number, nullable, required — When a rate is assessed on unit number greater than one. - `usageUnit` string, nullable, required — The unit of measurement for energy or water usage, such as kWh (kilowatt-hour) or gallons. - `correlationIds` string[], required — A list of correlationIds cascaded from all directly associated Credentials and Files. - `createdAt` string, date-time, nullable, required — A timestamp indicating when the entity was created. - `credentialIds` string[], required — An unique identifier for a credential. - `currencyCode` 'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS', nullable, required — The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time. - `customerNumber` string, nullable, required — The bill contains a unique identifier for the customer associated with the account. This is not the account number - `cycleNumber` string, nullable, required — The code or ID for a meter reading schedule. - `dataIngestionMethod` 'BILL_UPLOAD' | 'UTILITY_WEBSITE_ACCESS', nullable, required — Indicates the method you used to send data to us. - `disconnectDate` string, date, nullable, required — The date on which the service for the account was disconnected. - `discountBeforeDueDate` number, nullable, required — Any discounts applied to the account if the outstanding balance is paid before the due date. - `discoveredAt` string, date-time, nullable, required — Timestamp indicating when the statement data was discovered and added to the system. - `discoveredStatementId` string, nullable, required — The unique identifier for the discovered statement in the Arcadia platform. - `dueDate` string, date, nullable, required — The due date for payment associated with the account. - `id` string, required — A unique identifier for the entity. - `invoiceNumber` string, nullable, required — The unique identifier or number assigned to a specific invoice. - `isFinalBill` boolean, required — Indicates whether the current bill is the final bill for the account. - `isLatestVersion` boolean, required — Indicates if this is the latest/default version of the statement. - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified. - `newCharges` number, nullable, required — Any new charges applied to the account since the last billing cycle or statement. - `normalizedSummaryAccountNumber` string, nullable, required — The normalized version of the Summary account number (removing things like hyphens, underscores, and leading zeros). - `outstandingBalance` number, nullable, required — The remaining balance yet to be paid for the account. - `periodEndDate` string, date, nullable, required — The end date of the measuring period. - `periodStartDate` string, date, nullable, required — The start date of the measuring period. - `previousBalance` number, nullable, required — The balance carried forward from the previous billing period. - `previousStatementDate` string, date, nullable, required — The date of the previous bill. - `provider` PublicProviderResource, nullable, required — The entity providing service and issuing bills (informally known as a utility). - `country` string, nullable, required — The country associated with the billing address. - `id` string, required — A unique identifier for the entity. - `intervalServiceTypes` string[], required — List of interval service types supported by this provider (e.g., ['electric', 'gas']) - `isIntervalDataSupported` boolean, nullable, required — Indicates whether the provider supports interval data - `isIntervalFileUploadSupported` boolean, nullable, required — Indicates whether the provider supports interval file upload - `isRealTimeCredentialValidationSupported` boolean, required — Indicates whether the provider supports credential validation - `name` string, nullable, required — The name of the utility service provider. - `sourceType` 'TAG_NAME' | 'UNCLASSIFIED' | 'HTML' | 'CSS' | 'PNG' | 'JPG' | 'GIF' | 'TIFF' | 'SVG' | 'WEBP' | 'ICO' | 'PDF' | 'JSON' | 'CSV' | 'XML' | 'XLS' | 'XLSX' | 'TXT' | 'ZIP' | 'MSOTF' | 'OTF' | 'SFNT' | 'TTF' | 'WOFF' | 'WOFF2' | 'FONT_WOFF' | 'FONT_WOFF2' | 'FONT_XWOFF' | 'FONT_TTF' | 'FONT_SFNT' | 'URJA_NODE_LIST' | 'URJA_NAV_HISTORY' | 'INSERT_BILL' | 'EDI' | 'X12' | 'EDIFACT' | 'TRADACOMS' | 'WOOT', nullable, required — The data format of the data extraction source we used. - `statementDate` string, date, nullable, required — The date of the statement. - `summaryAccountId` string, nullable, required — The unique identifier of the summary account. - `summaryAccountNumber` string, nullable, required — The number or identifier assigned to the summary account by the provider. - `totalCharges` number, nullable, required — The total charges applied for a specific billing period. - `type` 'BILL' | 'NOTICE' | 'ADJUSTMENT' | 'PREPAID', nullable, required — Describes the source document. - `versionId` string, required — The unique identifier for the statement version. --- [API](https://skmtc.net/arcadia/apis/plug-api.md) · [All operations](https://skmtc.net/arcadia/apis/plug-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arcadia/plug-api/versions/d00587742116/schema)