Note that these tables only include fields that have been renamed or removed - they do not include new fields on these resources.
| Resource | Legacy Plug Field | 2024-02-21 Field (Detailed Statement) |
|---|
| All | client_user_id | correlationId - note that this field is only included in Credential and File response schemas currently, but can be used to search for Accounts, Meters and Statements. |
| All | created_at | createdAt |
| All | sandboxed | Not included in response schemas |
| All | updated_at | lastModifiedAt |
| All | utility_name | provider.name |
| All | utility_long_name | n/a |
| Resource | Legacy Plug Field | 2024-02-21Field (Detailed Statement) |
|---|
| Account | utility_credential_id | Not included in the Account schema, but accountIds is a search option on the List Credentials endpoint |
| Account | account_number | accountNumber |
| Account | service_address_street_one | Removed from the Account schema but is available from a Detailed Statement response under accountData[].billingAddress |
| Account | service_address_street_two | Removed from the Account schema but is available from a Detailed Statement response under accountData[].billingAddress |
| Account | service_address_city | Removed from the Account schema but is available from a Detailed Statement response under accountData[].billingAddress |
| Account | service_address_state | Removed from the Account schema but is available from a Detailed Statement response under accountData[].billingAddress |
| Account | service_address_zip | Removed from the Account schema but is available from a Detailed Statement response under accountData[].billingAddress |
| Account | service_customer_name | Removed from the Account schema but is available from a Detailed Statement response under accountData[].billingAddress |
| Account | supplier_account_id | Removed from the Account schema but is available from a Detailed Statement response under accountData[].customerNumber |
| Account | status | status however the possible values have changed. This field reflects Arcadia's ability to access the account, not it's status within the Provider. See statusDetail as well. |
| Account | most_recent_tariff | Removed from the Account schema but is available from a Detailed Statement response under accountData[].charges[].tariff |
| Account | flags | n/a |
| Account | services | serviceTypes |
| Account | feature_availability | Feature availability as a concept has been removed, but the isStatementsProductActive field is similar. |
| Account | utility_meters | Not included in the Account schema, but accountId is a search option on the List Meters endpoint |
| Resource | Legacy Plug Field | 2024-02-21 Field (Detailed Statement) |
|---|
| Credential | accounts_load_in_progress | Roughly equivalent to status == 'CONNECTION_IN_PROGRESS' |
| Credential | verification_status | status and statusDetail |
| Credential | verification_updated_at | No equivalent, although nextScheduledAccountRunAt is available to know when verification will checked next |
| Credential | uses_test_scenario | No equivalent, but all sandboxed Credentials should use a test scenario. |
| Resource | Legacy Plug Field | 2024-02-21 Field (Detailed Statement) |
|---|
| Statement | tariff | accountData[].charges[].tariff - Note that only the tariffName is available, not a Genability main_tariff_id. |
| Statement | utility_account_id | accountData[].accountId |
| Statement | statement_date | statementDate |
| Statement | due_date | dueDate |
| Statement | service_start_date | periodStartDate |
| Statement | service_end_date | periodEndDate |
| Statement | kwh | accountData[].meterData[].totalUsage |
| Statement | utility_charge | accountData[].meterData[].totalCharges |
| Statement | supplier_charge | accountData[].meterData[].charges(need to identify the appropriate charge using the lifecycleStage field) |
| Statement | gas_charge | .accountData[].meterData[].charges(need to identify the appropriate charge using the lifecycleStage field) |
| Statement | past_due | outstandingBalance |
| Statement | pdf_url | Not included in the response schema, but can be downloaded directly from the Download Statement Source endpoint. |
| Statement | final_bill | disconnectDate |
| Statement | service_window_inclusive_of_end_date | Not available yet |
| Statement | virtual_net_metering | Not available yet |
| Statement | most_recent_payment_detail | Not included in the response schema, but see the List Account's Payments endpoint |
| Statement | commercial_line_items_detail | This information should be available in accountData[].meterData[] |
| Statement | billing_flags | n/a |
