General
When a contract is created, it's critical to know the exact data that that went into the documents. Additionally, it's necessary to know what data was signed and approved. Sighten EverBright tracks this information through Data Baselines.
Definitions
A Data Snapshot, or snapshot, is a technique for capturing all the data on a job at a specific moment.
...
There are three baselines: proposed, signed, and approved. A proposed baseline is created when a contract is generated. A proposed baseline becomes signed when the associated contract is signed by all necessary parties. Finally, a signed baseline becomes approved when the financier approves the relevant milestone.
Accessing the baselines
The process for accessing data baseline metrics is very similar to the general process for using the Data Access Layer (DAL); documentation can be found here. So, to retrieve data from metrics in the proposed, signed, and approved baselines, you will use the key with 'p', 's', and 'a', respectively.
Method 1:
At the end of your DAL request, simply add the parameter: '&baseline=<key>', where key is any of 'p', 's', and 'a'.
Method 2:
Just as one specifies metrics when using the DAL, you simply prefix the desired metric with an indicator and specify metrics in the same manner. So So, to retrieve data from metrics in the proposed, signed, and approved baselines, you prefix each metric with 'p_', 's_', and 'a_', respectively.
Example
Sample Request:
.../api/data/quote/c51c6a53-8793-428e-8542-2d84b662bfe7/?metrics=system_capacity_kw,p_system_capacity_kw,s_system_capacity_kw,a_system_capacity_kw
where I am specifying a quote_id. All three baseline metrics and the base metric are included in this request. The base metric represents the data live in the job.
Sample Response:
"data":[
{
"s_system_capacity_kw":3.5,
"p_system_capacity_kw":4,
"a_system_capacity_kw":"APPROVED_BASELINE_NONEXISTANT",
"system_capacity_kw":4
}
]
Analyzing the results, we see the proposed baseline metric and base metric are equal to 4 kW. The signed baseline metric shows 3.5 kW. This implies the installer went back into the system, updated the system size, and then generated a new contract and subsequently a new baseline. However, this new contract has not yet been signed as the signed baseline metric has not been updated. Furthermore, we see that the approved baseline does not exist. A warning like this will appear for all baselines when the specified baseline does not exist. In this example, the warning implies the financier has not yet approved a milestone.
Related articles
You might also want to check out these related topics: