Utility Cloud – Data Dictionary

Provider Data

Field Name	Field	Type	Description
Provider Name	providerName	String	The commonly known name for the utility company. This field is searchable.
Has Multi Factor Authentication	hasMultiFactorAuthentication	Boolean	Indicates if a provider has some for of multi-factor authentication, captcha, reCAPTCHA, or security question
Required Fields	requiredFields	[String]	The inputs needed to submit a request for this provider
Required Field Metadata	requiredFieldMetadata	[Object]	Detailed information about the required input fields for this provider
Support Real-Time Credential Validation	supportsCredentialValidation	Boolean	Whether this provider supports Real-Time validation of credentials. If enabled, credentials can be checked for validity in less than 45 seconds. This field is searchable.
Country Of Operation	country	String	The primary country of operation for this provider. This field is searchable.
Enabled Solutions	enabledSolutions	[String]	A list of the solutions supported by this provider
Service Types	serviceTypes	[String]	A list of the service types that this provider supports. This field is not searchable.
Provider ID	providerId	[String]	The primary key used to represent this provider
Provider Website	website	String	The link Urjanet will use to access the provider’s website. This field is searchable.
Has Prepaid	hasPrepaid	Boolean	Indicates that a provider supports prepaid statements.
Has Postpaid	hasPostpaid	Boolean	Indicates that a provider supports postpaid statements
Mock (Provider)	mock	Boolean	Indicates that a provider is a mock provider for testing

Credential Data

Field Name	Field	Type	Description
Created (Credential)	created	Date	The Date the credential was registered in Urjanet’s system
Created By (Credential)	createdBy	String	The system user responsible for creating a credential
Enabled (Credential)	enabled	Boolean	Indicates whether data will continue to be extracted behind this credential.
Last Modified (Credential)	lastModified	Date	The date that a credential was modified last
Last Modified By (Credential)	lastModifiedBy	String	The system user responsible for modifying a credential most recently
Next Scheduled Run	nextScheduledRun	Date	The time that this credential is next scheduled to be ran in our system
Status (Credential)	status	String	Credential-level statuses that let you know if there are any issues accessing the provider portal, the data, or with the credential itself.
Status Detail (Credential)	statusDetail	String	A detailed status for the credential
Username	username	String	The provider username
Username 2	username2	String	Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider
Username 3	username3	String	Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider
Username 4	username4	String	Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider
Password	password	String	A sensitive input required to access the customer’s utility data.
Password 2	password2	String	Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider.
Password 3	password3	String	Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider.
Password 4	password4	String	Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider.
Update Credential URL	updateUrl	String (link)	URL that allows a user to update their password for a specified credential via Connect. The URL generated will only work for 72 hours after it is generated.
Update Credential URL Expiration	expiration	Date	The data and time that the update credential URL will expire
Provider Name	providerName	String	The commonly known name for the utility company.
Run History	runHistory	Boolean	Indicates if history is pulled. This will always be true.
Mock (Credential)	mock	Boolean	Indicates a test credential. Test credentials are submitted through a mock provider for testing.
Total Accounts	totalAccounts	Integer	Number of accounts behind this credential.

Account Data

Field Name	Field	Type	Description
Status (Account)	status	String	Account-level statuses that let you know if there are any issues accessing the account or the statement behind the account.
Status Detail (Account)	statusDetail	String	A detailed status for the account.
Type (Account)	type	String	Indicates if an account is a normal account, summary account, or sub-account. Responses are NORMAL, SUMMARY, and SUB_ACCOUNT
Meter Count	meterCount	Integer	The number of meters behind this account.
Enabled (Account)	enabled	Boolean	Indicates if an account is active (meaning we are actively monitoring the account)
Account Number	accountNumber	String	The Account number as extracted from the source
Normalized Account Number	normalizedAccountNumber	String	The account number normalized (removing things like hyphens, underscores, and leading 0’s)
Provider Name	providerName	String	The commonly known name for the utility company.
Prepaid	prepaid	Boolean	Indicates that an account is prepaid.
Created (Account)	created	Date	The Date the account was registered in Urjanet’s system
Created By (Account)	createdBy	String	The system user responsible for creating a account
Event Type (Account)	eventType	String	Describes the change that has been made to an account.
Field Changed (Account Events)	fieldName	String	For custom data changes, represents which custom data field was modified
Updated Field Value (Account Events)	newValue	String	For custom data changes, represents the newly assigned value of the field
Old Field Value (Account Events)	oldValue	String	For custom data changes, represents the previous value of the field
Last Modified (Account)	lastModified	Date	The date that an account was modified last
Last Modified By (Account)	lastModifiedBy	String	The system user responsible for modifying an account most recently
Latest New Statement	latestNewStatement	Date	This represents when we’ve most recently stored any newly extracted data for this account
Latest Statement Date	latestStatementDate	Date	This is the most recent statement date among all statements extracted for this account
First Extracted	firstExtracted	Date	The Date that the first extraction job completed for this account.

Statement Data

Field Name	Field	Type	Description
Statement Date	statementDate	Date	Date the statement was released by utility company
Amount Due By Date	amountDueByDate	Date	Due date from the bill
New Charges	newCharges	Number	New charges on a utility statement
Total Charges	totalCharges	Number	Total of all charges on a utility statement
Outstanding Balance	outstandingBalance	Number	The balance on an account that was not paid in full
Previous Balance	previousBalance	Number	The balance on the previous statement
Amount Due	amountDue	Number	Amount due from the bill
Start Date	startDate	Date	Date that the billing period started
End Date	endDate	Date	Date that the billing period ended
Service Address	serviceAddress	Embedded Address Object	Address receiving the service
Billing Address	billingAddress	Embedded Address Object	Address where the bills are sent
Payment Address	paymentAddress	Embedded Address Object	Address that can receive payment
Recipient	recipient	String	The recipient on the address
City	city	String	The parsed city from the address
Country	country	String	The parsed country from the address
Postal Code	postalCode	String	The parsed postal code from the address
Raw Address	rawAddress	String	The raw address from the bill
State	state	String	The parsed state from the address
Street Address	streetLine1	String	The parsed first line of the street address from the address
Street Address Line 2	streetLine2	String	The parsed second line of the street address from the address
Invoice Number	invoiceNumber	String	Utility-assigned unique identifier for the invoice
Late Fee	lateFees	Number	The quantity owed for late payment
Statement Type	statementType	String	Describes the source document. Options are BILL, NOTICE, ADJUSTMENT, and PREPAID
Created (Statement)	created	Date	The Date the statement was created in Urjanet’s system
Discovered Date	discoveredDate	Date	The Date the statement was discovered by Urjanet’s system
Last Modified	lastModified	Date	The Date the statement data was last modified in Urjanet’s system
Provider Name	providerName	String	The commonly known name for the utility company
Provider Name	providerAlias	String	The Urjanet’s system name for the utility company
Amount Due After Due Date	amountDueAfterDueDate	Number	The amount due if you pay late for a specific utility provider
Amount Due Before Due Date	amountDueBeforeDueDate	Number	The amount due if you pay early for a specific utility provider
Outstanding Balance	outstandingBalance	Number	The balance carry forward from a prior utility statement
Customer Number	customerNumber	Number	The statement contains a unique identifier as a customer number. This is not the account number
Cycle Number	cycleNumber	Number	The code or ID for a meter reading schedule
Facility Number	facilityNumber	Number	The statement contains a unique identifier as a facility number. This is not the account number
Facility Name	facilityName	String	The statement contains a name for a specific facility
Final Bill Notice	finalBillNotice	String	This can be either a first disconnect warning or the notice that a final billing has occurred (where applicable).
Map Number	mapNumber	Number	Like cycle number, the code or ID indicates a meter reading schedule
Disconnect Date	disconnectDate	Date	When a final bill notice is flagged, this is the date when the service is disconnected.
Usages	usages	Number	Statement level usages are specific to summary/consolidated billing
Charges	charges	Number	Statement level charges are specific to summary/consolidated billing
Provider Classification	providerClassification	String	The provider classification is how Urjanet attempts to track the role a utility provider has played on invoices over the course of Urjanet’s history of extracting an account. The provider classification field is not intended to tell the difference between supply and delivery. If Urjanet has seen a provider play both of these roles for an account over time, its provider classification will be both.
Additional Provider Alias	additionalProviderAlias	String	A primary provider issues the invoice and a secondary provider is only mentioned or cited via pass-thru charges. The secondary provider will be the additional provider alias when applicable

Payment Data

Field Name	Field	Type	Description
Amount	amount	Number	The total amount that was paid
Payment Date	paymentDate	Date	Date the payment was made
Currency	currency	String	Currency used by the provider when representing the amount that was paid

Meter Data

Field Name	Field	Type	Description
Service Type	serviceType	String	The meter’s service type.
Meter Read Date	meterReadDate	String	The date when this meter was read on this statement
Previous Read Date	prevReadDate	String	The previous date when this meter was read on the statement
Meter Number	meterNumber	String	The meter number as extracted from the source
Normalized Meter Number	normalizedMeterNumber	String	The meter number normalized (removing things like hyphens, underscores, and leading 0’s)
Deregulation Status	deregulationStatus	String	Supply only, delivery only, or full service
Service Address	serviceAddress	Embedded Address Object	Address receiving the utility service
Contribution Status	contributionStatus	String	Non-contributing is not calculated for audits or total charges or total usages
Total Charges	totalCharges	Number	Total of all charges on this meter on the utility statement
Total Usage	totalUsage	Number	Total of all usages on this meter on the utility statement
Total Usage Unit	totalUsageUnit	String	The meter’s total usage unit of measure
Account Numbers	accountNumbers	Array	The reference to all account numbers associated over time to this meter
Created	created	Date	The date when this meter was created in Urjanet’s system
Previous Meter Number	previousMeterNumber	String	When a meter number change occurs, this is the previous meter number printed on the statement.
Normalized Previous Meter Number	normalizedPreviousMeterNumber	String	Removes non-standard characters from the previous meter number
Pod Number	podNumber	String	The point of delivery number in deregulated markets. This is an independent identifier for meter location and used by all utility companies in deregulated markets.
Normalized Pod Number	normalizedPodNumber	String	Removes non-standard characters from the pod number
Meter Constant Multiplier	meterConstantMultiplier	Number	The first conversion after the meter delta is calculated
Previous Meter Constant Multiplier	previousMeterConstantMultiplier	Number	When a meter number change occurs, this is the previous meter constant multiplier printed on the statement.
Service Description	serviceDescription	String	The meter description of the service
Bulb Type	bulbType	String	When the meter is lighting, this field describes the bulb type
Pipe Type	pipeType	String	When the meter is water, this field describes the pipe type

Charge Data

Field Name	Field	Type	Description
Measured Usage	measuredUsage	Number	Represents actual consumption at the meter location
Meter Reading Raw	meterReadingRaw	Number	The raw reading from the meter on the utility statement
Meter Reading Raw Previous	meterReadingRawPrevious	Number	The previous raw reading from the meter on the utility statement
Meter Constant Multiplier	meterConstantMultiplier	Number	Meter raw reads constant multiplier to convert raw reading to comodity amount
Usage Actual Name	usageActualName	String	The usage name on the utility statement
Contribution Status	contributionStatus	String	Non-contributing is not calculated for audits or total charges or total usages
Usage Unit	usageUnit	String	The meter’s usage unit of measure
Measurement Type	measurementType	String	Delivery terms of the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries
Meter Read Type	meterReadType	String	Meter’s most recent read date in the statement. This field can be acutal or estimated
Previous Meter Read Type	previousMeterReadType	String	Meter’s previous read date in the statement. This field can be acutal or estimated
Tariff Rate Components	tariffRateComponents	Array	Array of tariffs
Tariff Name	tariffName	String	The tariff name on the utility statement
Traiff Rate Component Type	tariffRateComponentType	String	Rate components are also known as tariff rate components and are a way to establish the purpose/classification of a charge with respect to the rate plan.
Cited Usage	citedUsage	Number	This usage is not measured by a meter reading on the current statement
Measured Usage	measuredUsage	Number	This usage is measured by a meter reading on the current statement
Noncoincidental Usage	noncoincidentalUsage	Number	This a special type of electric demand reading
Hours of Use	hoursOfUse	String	Any time of use tariff
Load Factor	loadFactor	Number	The observed load factor on the meter
Power Factor	powerFactor	Number	The observed power factor on the meter
Previous Usage	previousUsage	Number	A prior period’s usage amount is published by a meter reading on the current statement
Meter Reading Delta	meterReadingDelta	Number	The raw reading difference from the meter printed on the statement
Meter Reading Delta Previous	meterReadingDeltaPrevious	Number	The raw reading difference from the meter from the previous month printed on the current statement
Number of Days in Period	numberOfDaysInPeriod	Number	The number of days in a billing cycle printed on the bill
Pressure Multiplier	pressureMultiplier	Number	Additional multiplier, if required, to measure units used (for natural gas)
Meter Constant Multiplier	meterConstantMultiplier	Number	The first conversion after the meter delta is calculated
Meter Conversion Multiplier	meterConversionMultiplier	Number	Conversion factor, when required, for delivering a change in units of measure
Calorific Value	calorificValue	Number	Conversion multiplier to heat
Read Type as Printed	readTypeAsPrinted	String	Field for determining if read was actual or estimated as printed on the bill
Previous Read Type as Printed	previousReadTypeAsPrinted	String	Field for determining if read was actual or estimated for the last statement as printed on the bill
Rate or Tariff Actual Name	rateOrTariffActualName	String	Name of the rate or tariff
Reading Schedule	readingSchedule	String	Published meter reading schedule
Outage Block	outageBlock	String	Published outage block schedule
Meter Read Date	meterReadDate	Date	Date the meter was read
Prev Read Date	prevReadDate	Date	Date of the last time the meter was read on the current statement
Meter Reading Usage Delta Unit	meterReadingUsageDeltaUnit	String	Commodity energy unit when specified for meter reading deltas

Usage Data

Field Name	Field	Type	Description
Charge Amount	chargeAmount	Number	The line item charge amount
Charge Actual Name	chargeActualName	String	The charge name on the utility statement
Charge Name	Charge Name	String	Urjanet’s system category for the charges.
Charge Amount Currency	chargeAmountCurrency	String	Currency used by the provider when representing the amount that was charged
Charge Rate Currency	chargeRateCurrency	String	The rate per commodity unit for a specific charge.
Tariff Rate Components	tariffRateComponents	String	Rate components are also known as tariff rate components and are a way to establish the purpose/classification of a charge with respect to the rate plan.
Created (Tariff)	created	Date	The Date the tariff was registered in Urjanet’s system
Tariff Name	tariffName	String	The tariff name on the utility statement
Provider Alias	providerAlias	String	Urjanet’s system name for the utility company
Provider Name	providerName	String	The commonly known name for the utility company
Contribution Status	contributionStatus	String	Non-contributing is not calculated for audits or total charges or total usages
Charge Type	chargeType	String	Debit or Credit
Charge Amount	chargeAmount	Number	The amount for a line item charge
Charge Group Heading	chargeGroupHeading	String	Additional charge description
Lifecycle Stage	lifecycleStage	String	Lifecycle section for a specific charge. Values can be: bundled, generation, transmission, distribution, combined delivery
Measurement Type	measurementType	String	Delivery terms of the tariff: General consumption, demand, bi-directional in, bi-directional out, deduct, deliveries, base, nomination, positive inbalance, negative inbalance
Usage Unit	usageUnit	String	The meter’s usage unit of measure
Charge Units Used	chargeUnitsUsed	String	Units measured for any variable charges, where declared (not calculated)
Charge Rate	chargeRate	Number	Price/rate per unit when declared on the invoice (not calculated)
Charge Rate Base	chargeRateBase	Number	A base rate for a specific charge when printed on the bill
Charge Rate Adder	chargeRateAdder	Number	An adder for the base rate for a specific charge when printed on the bill
Units Per Rate	unitsPerRate	Number	When a rate is assessed on unit number greater than 1
Additional Rate Multiplier	additionalRateMultiplier	Number	If necessary, a second rate multiplier as printed on the bill

Site Data

Field Name	Field	Type	Description
Last Modified (Site)	lastModified	Date	The date that the site was last modified in Urjanet’s system
Created (Site)	created	Date	The date that the site was created in Urjanet’s system
Created By (Site)	createdBy	String	The system user responsible for creating a site
Last Modified By (Site)	lastModifiedBy	String	The system user responsible for modifying the site most recently
Site Number	siteNumber	String	Custom field to input site number. This field is optional
Site Name	siteName	String	Custom field to input site name. This field is optional
Site Code	siteCode	String	Custom field to input site code. This field is optional
Region	region	String	Custom field to input site’s region. This field is optional
Sub Region	subRegion	String	Custom field to input site’s sub region. This field is optional
Facility Type	facilityType	String	Custom field to input site’s facility type. This field is optional
Service Address	serviceAddress	String	The service address for this site
Recipient	recipient	String	The recipient on the address
Street Line 1	streetLine1	String	The parsed first line of the street address from the address
Street Line 2	streetLine2	String	The parsed second line of the street address from the address
City	city	String	The parsed city from the address
State	state	String	The parsed state from the address
Country	country	String	The parsed country from the address
Postal Code	postalCode	String	The parsed postal code from the address
Full Address	fullAddress	String	The full service address

Custom Data

Field Name	Field	Type	Description
Account Custom Data Field 1	accountCustomData1Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 2	accountCustomData2Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 3	accountCustomData3Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 4	accountCustomData4Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 5	accountCustomData5Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 6	accountCustomData6Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 7	accountCustomData7Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 8	accountCustomData8Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 9	accountCustomData9Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Account Custom Data Field 10	accountCustomData10Name	String	Customer-created field that can be set at the account level. There can be up to 10 different custom data fields.
Meter Custom Data Field 1	meterCustomData1Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 2	meterCustomData2Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 3	meterCustomData3Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 4	meterCustomData4Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 5	meterCustomData5Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 6	meterCustomData6Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 7	meterCustomData7Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 8	meterCustomData8Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 9	meterCustomData9Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Meter Custom Data Field 10	meterCustomData10Name	String	Customer-created field that can be set at the meter level. There can be up to 10 different custom data fields.
Name	name	String	Your Urjanet organization’s name
Correlation ID	correlationId	String	A credential level value set by you. It can be any string you would like.
Download Link	download	String (link)	Link to download data or source document
Created Date (Download Link)	createdDate	Date	The date and time that the link to download a file was created.

Organization Data

Field Name	Field	Type	Description
Allowed Email Domains	allowedEmailDomains	String	Comma-separated list of allowed e-mail domains for users within this organization
Created By (Organization)	createdBy	String	User who created this organization
Default Webhook URL	defaultWebhookUrl	String (link)	The webhook URL used with Urjanet Connect integration
Default Job Timeout	defaultTimeout	String	The timeout value used with Urjanet Connect integration
Default Historical Job Date Range	defaultDataCapturePeriodMonths	String	The number of months of data that will be extracted
Created Date (Organization)	createdDate	Date	Date the organization was created
Last Modified By (Organization)	lastModifiedBy	String	Most recent user to modify this organization
Last Modified Date (Organization)	lastModifiedDate	Date	Date this organization was most recently modified
Organization Name	name	String	Name of this organization
Privacy Policy URL	privacyPolicy	String (link)	A URL for your company’s privacy policy. This will be linked in the Urjanet Connect UI
Terms Of Service URL	termsOfService	String (link)	A URL for your company’s terms of service. This will be linked in the Urjanet Connect UI
Organization Unique ID	uniqueId	String	Unique ID for the Organization

User Data

Field Name	Field	Type	Description
Created By (User)	createdBy	String	User who added the user in question to the organization.
Created Date (User)	createdDate	Date	Date the users was added to the organization
Last Modified By (User)	lastModifiedBy	String	Most recent user to modify a user
Last Modified Date (User)	lastModifiedDate	Date	Date this user was most recently modified
Name (user)	name	String	User’s name
Email	email	String	The user’s email
Name (Role)	name	String	Name of the user’s role

Consent Data

Field Name	Field	Type	Description
Consent Status	consentStatus	String	Indicates if the status of consent is active or otherwise.
Credential Created Date	credentialCreatedDate	Date	The date that the credential was collected and consent was received
Last Modified Date	lastModifiedDate	Date	If consent was modified, this indicates the date it was modified
Origin of Consent	origin	String	Indicates the source responsible for collecting consent and credentials. Response can be API or CONNECT
Privacy Policy URL	privacyPolicyUrl	String (link)	Link to the privacy policy that the user consented to
Revoke Consent Date	revokeDate	Date	Date that the user revoked their consent
Terms of Service URL	termsOfServiceUrl	String (link)	Link to the terms of service that the user consented to