|
BillDescriptorJson properties
| Property |
Description |
Type |
| confidence |
|
BillDescriptorJson+BillDescriptorConfidence |
|
BillDescriptorJson+BillDescriptorConfidence properties
| Property |
Description |
Type |
| confidenceScore |
A number between 0 and 1 representing percentage confident in extraction results. 100% is “totally confident”. |
number (double) |
| lowConfidenceReason |
A plain text explanation of why confidence is low if available. Can be blank if no confidence impacting issues detected. |
string |
|
| controlCode |
The name of the input file, without file extension, for linking results to document source for extraction |
string |
| header |
|
BillDescriptorJson+BillDescriptorHeaderJson |
|
BillDescriptorJson+BillDescriptorHeaderJson properties
| Property |
Description |
Type |
| accountIdentifiers |
A list of label-value pairs that may be used to identify the account. For example Customer ID, Supplier Agreement ID, Site ID, Metering Location ID, Service Point ID, Agreement ID, etc.
Labels and values should appear as they do on the bill. |
BillDescriptorJson+BillDescriptorIdentifier[] |
|
BillDescriptorJson+BillDescriptorIdentifier properties
| Property |
Description |
Type |
| label |
The label of the identifier |
string |
| value |
The value of the identifier |
string |
|
| accountLevelCharges |
A list of charge line items that are not related to any meter on the bill.
Any charges that are derived from the amount of metered usage should be attached to the relevant meter instead.
This is often empty |
BillDescriptorJson+BillDescriptorChargeLineItem[] |
|
BillDescriptorJson+BillDescriptorChargeLineItem properties
| Property |
Description |
Type |
| caption |
Caption / Description of the line item |
string |
| cost |
Cost of the line item.
Unlike meter line items, may not be NULL as a charge line has no other countable value. |
number (double) |
| ignoreValidation |
Utilized by Bill CAPture processing. When true, validation that would otherwise apply to this charge is skipped.
This value is not utilized by bill import or bill processing rules. |
boolean |
| observationType |
The observation type code classifying this line item (e.g., CHARGE, TAX, CUSTOMERCHARGE, LATEFEE).
Must be a valid EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorChargeLineItem.ObservationType value. |
string |
|
| accountNumber |
Primary account number on the bill.
Other items that may identify the account can be added to EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorHeaderJson.AccountIdentifiers.
This will generally appear there as well and may be the only entry. |
string |
| billEnd |
The end date of the bill, if available.
Must be in ISO-8601 format. |
string (date-time) |
| billStart |
The start date of the bill, if available.
Must be in ISO-8601 format. |
string (date-time) |
| currencyCode |
The currency of all cost line items on the bill.
Use the ISO-4217 3-character list () |
string |
| currentCharges |
The total amount of charges incurred only by this bill.
Does not include late fees, balance carried forward from prior bills, etc. |
number (double) |
| customerAddress |
|
BillDescriptorJson+BillDescriptorAddress |
|
BillDescriptorJson+BillDescriptorAddress properties
| Property |
Description |
Type |
| attention |
Attention or care-of line, exactly as printed including any prefix (e.g., ‘Attn: Accounts Payable’, ‘c/o Facilities’).
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if not present. |
string |
| city |
The city |
string |
| country |
The country, as an ISO 3166-1 alpha-2 two character code (e.g. ‘US’, ‘CA’, ‘GB’)
() |
string |
| line1 |
The first line of the street address |
string |
| line2 |
The second line of the street address, if present |
string |
| line3 |
The third line of the street address, if present |
string |
| postalCode |
The postal or ZIP code |
string |
| recipient |
Name of the person, business, site, or department the address is for, as printed (e.g., ‘Payment Processing Center’), including the vendor’s own name when it is printed with the address.
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if no name is printed. |
string |
| state |
The state, province or region |
string |
|
| daysOfService |
The number of days in the service period, if available. Also known as “Billing Days”, “Days in Period”, etc |
integer (int32) |
| deliveryDate |
For bills that have only a single date like fuel oil or propane deliveries, use this rather than EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorHeaderJson.BillStart and EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorHeaderJson.BillEnd.
Must be in ISO-8601 format. |
string (date-time) |
| dueDate |
When the bill payment is due. Also called Remit Date, Pay By, Expiration Date, Penalty if not paid before, etc.
Must be in ISO-8601 format. |
string (date-time) |
| estimated |
true if any meter readings used to calculate the bill were estimated or the bill indicates that it was estimated.
Equivalent to the “E” flag of A/C/E in the advanced import format.
When both this and EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorHeaderJson.IsCorrection are true the
bill is imported as a correction and not marked estimated, so that no existing bill data is lost. |
boolean |
| invoiceDate |
Also called statement date, issue date. The effective date on which the bill amounts were calculated.
Must be in ISO-8601 format. |
string (date-time) |
| invoiceNumber |
Also known as “bill number”, “Bill ID”, “Document Number” |
string |
| isCorrection |
true if this bill corrects a bill previously issued for the same account and period.
A correction never replaces the existing bill. Equivalent to the “C” flag of A/C/E in the advanced import format.
When both this and EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorHeaderJson.Estimated are true the bill is imported as a correction and not marked estimated, so that no existing bill data is lost. |
boolean |
| mailingDate |
When the bill was sent by the utility provider.
Must be in ISO-8601 format. |
string (date-time) |
| overlapBehavior |
What to do when a bill already exists for the same account and period. One of ‘voidExistingBill’,
‘preserveExistingBill’, or ‘rejectNewBill’.
Equivalent to the V/P/R flag in the advanced import format.
When absent the importing system’s default applies. |
string |
| rateSchedule |
Label-value pairs representing information about the rate defining the bill.
Often only one present. |
BillDescriptorJson+BillDescriptorIdentifier[] |
|
BillDescriptorJson+BillDescriptorIdentifier properties
| Property |
Description |
Type |
| label |
The label of the identifier |
string |
| value |
The value of the identifier |
string |
|
| remitAddress |
|
BillDescriptorJson+BillDescriptorAddress |
|
BillDescriptorJson+BillDescriptorAddress properties
| Property |
Description |
Type |
| attention |
Attention or care-of line, exactly as printed including any prefix (e.g., ‘Attn: Accounts Payable’, ‘c/o Facilities’).
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if not present. |
string |
| city |
The city |
string |
| country |
The country, as an ISO 3166-1 alpha-2 two character code (e.g. ‘US’, ‘CA’, ‘GB’)
() |
string |
| line1 |
The first line of the street address |
string |
| line2 |
The second line of the street address, if present |
string |
| line3 |
The third line of the street address, if present |
string |
| postalCode |
The postal or ZIP code |
string |
| recipient |
Name of the person, business, site, or department the address is for, as printed (e.g., ‘Payment Processing Center’), including the vendor’s own name when it is printed with the address.
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if no name is printed. |
string |
| state |
The state, province or region |
string |
|
| servicePeriodMonth |
Abbreviated US English month name, e.g. “Jan”, “Feb”, “Mar”, etc |
string |
| sourceLanguage |
The source language of the bill, in ISO-639 Set 2 () |
string |
| totalCost |
The total amount due on the bill, also known as “Total Amount Due”, “Total Due”, “Amount Due”, “Net Amount”.
Includes prior balance and late fee. |
number (double) |
| vendorAddress |
|
BillDescriptorJson+BillDescriptorAddress |
|
BillDescriptorJson+BillDescriptorAddress properties
| Property |
Description |
Type |
| attention |
Attention or care-of line, exactly as printed including any prefix (e.g., ‘Attn: Accounts Payable’, ‘c/o Facilities’).
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if not present. |
string |
| city |
The city |
string |
| country |
The country, as an ISO 3166-1 alpha-2 two character code (e.g. ‘US’, ‘CA’, ‘GB’)
() |
string |
| line1 |
The first line of the street address |
string |
| line2 |
The second line of the street address, if present |
string |
| line3 |
The third line of the street address, if present |
string |
| postalCode |
The postal or ZIP code |
string |
| recipient |
Name of the person, business, site, or department the address is for, as printed (e.g., ‘Payment Processing Center’), including the vendor’s own name when it is printed with the address.
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if no name is printed. |
string |
| state |
The state, province or region |
string |
|
| vendorEmail |
The website of the vendor, if available |
string |
| vendorName |
The name of the Utility Vendor issuing the bill |
string |
| vendorPhoneNumber |
The main phone number of the vendor, if available |
string |
| vendorRole |
If available, one of ‘Supply’, ‘Distribution’ |
string |
| vendorWebsite |
The website of the vendor, if available |
string |
|
| meters |
Meters represented on the bill, including line items associated with each meter |
BillDescriptorJson+BillDescriptorMeterJson[] |
|
BillDescriptorJson+BillDescriptorMeterJson properties
| Property |
Description |
Type |
| commodity |
See commodity list provided separately. |
string |
| currentReadingDate |
The date of the current meter reading the bill’s usage is measured to, if available.
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Must be in ISO-8601 format. |
string (date-time) |
| identifiers |
A list of label-value pairs that may be used to identify the meter.
For example Meter Number, Serial Number, Tank Number, Site Name, Point of Delivery, Service Point, EZID, etc.
Labels and values should appear as they do on the bill. |
BillDescriptorJson+BillDescriptorIdentifier[] |
|
BillDescriptorJson+BillDescriptorIdentifier properties
| Property |
Description |
Type |
| label |
The label of the identifier |
string |
| value |
The value of the identifier |
string |
|
| lines |
A list of charges and usage values associated with this meter.
Each line may have a caption, a cost, a unit rate, a value and a unit. Value and Unit may indicate consumption, demand, etc.
Not all fields will be present on every line. For example a fixed monthly charge will not have a usage value or unit.
A value may be present without a cost if the bill shows the usage but does not charge for it.
Lines should appear in the order they appear on the bill whenever possible. |
BillDescriptorJson+BillDescriptorMeterLineItem[] |
|
BillDescriptorJson+BillDescriptorMeterLineItem properties
| Property |
Description |
Type |
| caption |
Caption / Description of the line item |
string |
| cost |
Cost of the line item.
Should be NULL if the line does not have a cost associated with it. Should be zero if the line has a cost, but it is 0. |
number (double) |
| observationType |
The observation type code classifying this line item (e.g., USE, DEMAND, CHARGE, TAX).
Must be a valid EnergyCap.DTO.Base.BillDescriptor.BillDescriptorJson.BillDescriptorMeterLineItem.ObservationType value. |
string |
| unit |
Value unit (e.g. kWh, Therms, Gallons, CCF, etc).
Units should be the unit code from the list of standard units provided separately (see unit-list.csv) |
string |
| unitRate |
Unit Rate should represent what is printed on the bill if present (it may differ based on rounding from a computed value). |
number (double) |
| value |
Value of the line item (e.g. quantity of energy, demand, or volume).
Should be NULL if the line does not have a value associated with it. Should be zero if the line has a value, but it is 0. |
number (double) |
|
| meterAddress |
|
BillDescriptorJson+BillDescriptorAddress |
|
BillDescriptorJson+BillDescriptorAddress properties
| Property |
Description |
Type |
| attention |
Attention or care-of line, exactly as printed including any prefix (e.g., ‘Attn: Accounts Payable’, ‘c/o Facilities’).
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if not present. |
string |
| city |
The city |
string |
| country |
The country, as an ISO 3166-1 alpha-2 two character code (e.g. ‘US’, ‘CA’, ‘GB’)
() |
string |
| line1 |
The first line of the street address |
string |
| line2 |
The second line of the street address, if present |
string |
| line3 |
The third line of the street address, if present |
string |
| postalCode |
The postal or ZIP code |
string |
| recipient |
Name of the person, business, site, or department the address is for, as printed (e.g., ‘Payment Processing Center’), including the vendor’s own name when it is printed with the address.
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Null if no name is printed. |
string |
| state |
The state, province or region |
string |
|
| previousReadingDate |
The date of the previous meter reading the bill’s usage is measured from, if available.
For use by bill processing rules, this is not automatically mapped to a field on the bill upon import.
Must be in ISO-8601 format. |
string (date-time) |
| rateSchedule |
label-value pairs representing information about the rate defining the bill. Often only one present. |
BillDescriptorJson+BillDescriptorIdentifier[] |
|
BillDescriptorJson+BillDescriptorIdentifier properties
| Property |
Description |
Type |
| label |
The label of the identifier |
string |
| value |
The value of the identifier |
string |
|
| serialNumber |
The serial number of the meter, if available |
string |
|
| processingErrors |
List of any problems that prevented extraction of bill data |
BillDescriptorJson+BillDescriptorProcessingError[] |
|
BillDescriptorJson+BillDescriptorProcessingError properties
| Property |
Description |
Type |
| errorMessage |
Whatever context will help to understand the problem. Free form text. |
string |
| errorReason |
A category for the error. “Invalid Scan”, “Encrypted File”, “Corrupt File”, “Unknown”, others as appropriate. |
string |
|
|