Modifying resources
Overview
The MRV API supports modifying resources through PATCH endpoints. If the change does not impact the values of calculations, the change will be immediately viewable by everyone that currently has access to the data, including verifiers. If the change does impact the value of calculations, we do not publish these changes to a verifier immediately but instead only when the GHG statement is resubmitted.
GHG statement submissions
A GHG statement needs to be submitted to be viewable to a verifier.
After changes to resources that impact carbon accounting calculations are made, the GHG statement must be resubmitted using the POST ghg_statements/{id}/resubmit
endpoint to make the changes visible to the verifier.
To know whether a GHG statement needs to be resubmitted, you can check the pending_total_co2e_removed_kg
value on the GHG statement resource.
If it is null, the GHG statement does not need to be resubmitted.
If it is non-null, it tells you the total value of the GHG statement after resubmission.
This allows a supplier to batch many changes at once and only show the verifier data in a more finalised state.
Example changes that require resubmission
The following is a non-exhaustive list of updates that will require a GHG statement to be resubmitted:
- A PATCH update to a datapoint that modifies the datapoint’s quantity
- A PATCH update to a component that modified the datapoint used as one of its inputs
- A PATCH update to a removal that adds or removes components.
Example changes that do not require a resubmission
- Adding or removing sources from a datapoint
- Updating display names or descriptions of resources.
Querying
Data returned through the MRV API is always the latest version of a resource. You cannot currently query previous versions and we have no plans to support this functionality. Instead, you should use the UI, which allows you to see the state of data at each GHG statement submission.
Was this page helpful?