Sign in
Uploads

Take a review group's account (every ledger:<account>|… group of it) outside the Scope 3 boundary, with a reason. The decision joins the upload's boundary policy and the organization's memory (source reviewer), and a regroup job moves the account's rows under boundary:account|<account>: they keep their money, lose their emission rows, and are never submitted. The group key is percent-encoded as one path segment.

post/uploads/{id}/factor-agent/groups/{groupKey}/exclude

Path parameters

idinteger required
groupKeystring required

Request body

reason'transfer_or_subvention' | 'financial_charges' | 'payroll_or_pension' | 'student_or_member_support' | 'fees_and_registration' | 'water' | 'waste_billed_separately' | 'tax_or_levy' | 'internal_or_balancing' | 'insurance_or_protection' | 'other' required

Response

The regroup job, queued. Poll GET .../factor-agent/jobs/{documentJobId} (kind regroup) until it ends; while it runs the analysis reads processing and names it (jobId). Its progress phases, in order: regroup_classify "Deciding the new keys", regroup_apply "Moving the rows", regroup_match "Matching emission factors", regroup_duplicates "Checking duplicate spend lines", regroup_finish "Finishing the review" (done and total count the rows the regroup moves). A regroup cannot be cancelled.

Changes

Changed in 1 of the 8 revisions of this API.1