Top-up enrichment

If finer-grained categorisation of your transactions is required, top-up enrichment can be requested to allow for more accurate carbon tracking. When enabled, the Carbon Engine will analyse a transaction's description and may assign an enriched category to the transaction on a match. This also means top-up enrichment only functions when transaction descriptions are supplied. If you are not sending descriptions through with transaction data, top-up enrichment will not be available.

This extra processing step will be run when calling all state-changing endpoints under the Transaction section and the stateless footprint endpoint.

When footprinting stored transactions, the enriched category will only be used when a transaction's category field has not been updated since its insertion via the PostUserTransactions endpoint. Submitting new transactions or modifiying existing transactions via the PutUserTransactions endpoint are also treated as updating the category field, so any enriched categories will be ignored.

Footprinting transactions via the stateless endpoint is always treated as an insert, so enriched categories will be used if present.