På denne siden

Referanse: Orgadmin API

Referansen er generert fra API-ets egen OpenAPI-spesifikasjon ved bygging av denne siden; spesifikasjonen kan lastes ned nedenfor for bruk i egne verktøy (kodegeneratorer, Postman, Bruno og lignende). Alle endepunkter krever autentisering — se Autentisering. Basis-URL-er for test og produksjon står under API integrasjon.

Spesifikasjonsversjon 1.255 · OpenAPI 3.0.3 · Last ned spesifikasjonen (YAML)

Access Grant Resource

`/{org}/access-grant`

GETList outgoing grants made by this organization. Requires write:organization.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — liste av AccessGrantDto

POSTCreate or replace a cross-tenant grant to a recipient organization. Requires write:organization in {org}.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — CreateAccessGrantDto

Svar

Status	Innhold
`200`	`application/json` — AccessGrantDto
`400`	–

`/{org}/access-grant/incoming`

GETList organizations that have granted this organization access (selector source).

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — liste av IncomingGrantDto

`/{org}/access-grant/{recipientOrg}`

PUTUpdate the access levels of an existing grant. Requires write:organization.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`recipientOrg` *	path	string

Forespørselskropp *

application/json — GrantAccessMap

Svar

Status	Innhold
`200`	`application/json` — AccessGrantDto
`400`	–

DELETERevoke the grant to a recipient organization. Requires write:organization.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`recipientOrg` *	path	string

Svar

Status	Innhold
`204`	–

Api Key Permissions Resource

`/api-key/last-used`

POSTRecord Usage

Parametre

Navn	I	Type	Beskrivelse
`clientId`	query	string

Svar

Status	Innhold
`200`	`application/json` — objekt

`/api-key/permissions`

GETGet Api Key Permissions

Parametre

Navn	I	Type	Beskrivelse
`clientId`	query	string

Svar

Status	Innhold
`200`	`application/json` — ApiKeyPermissionsResponseDto

Api Key Resource

`/{org}/api-key`

GETList the organization's API keys

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`range`	query	string

Svar

Status	Innhold
`200`	`application/json` — liste av ApiKeyDto

POSTCreate an API key; the response carries the secret exactly once

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — AddApiKeyDto

Svar

Status	Innhold
`200`	`application/json` — ApiKeyDto
`400`	–

`/{org}/api-key/{id}`

GETGet an API key (never includes the secret)

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — ApiKeyDto

PUTUpdate an API key's metadata, permissions, expiry or active flag

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Forespørselskropp *

application/json — UpdateApiKeyDto

Svar

Status	Innhold
`200`	`application/json` — ApiKeyDto
`400`	–

DELETEDelete an API key and its credential

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — map av integer (int64)

`/{org}/api-key/{id}/regenerate-secret`

POSTRotate the secret; the response carries the new secret exactly once

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — ApiKeyDto

Category Resource

`/{org}/category`

GETGet all categories for an organization including global categories (JSON format). If not authenticated, returns only the public RDF-S taxonomy. Returns localized category names based on Accept-Language header. Properties in the tree omit their enum options; read them from the single-category endpoint. Requires read:categories.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — TaxonomyDto `text/turtle` — string

`/{org}/category/{parentcategory}`

GETGet all subcategories for a given parent category. Returns localized category names based on Accept-Language header. Supports filtering with ?filter={"global":false} to exclude global categories. Under a logistics (location) parent requires read:locations; elsewhere requires read:categories.

Parametre

Navn	I	Type
`org` *	path	string
`parentcategory` *	path	string
`filter`	query	string
`range`	query	string

Svar

Status	Innhold
`200`	`application/json` — liste av CategoryDto

POSTAdd a new subcategory to the parent category. If parentCategoryId is provided in the request body, it takes precedence over the path parameter. Writes under a logistics (location) parent require write:locations; writes elsewhere require write:categories.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`parentcategory` *	path	string

Forespørselskropp *

application/json — AddCategoryDto

Svar

Status	Innhold
`400`	–
`409`	–

`/{org}/category/{parentcategory}/{categoryid}`

GETGet category information. Returns localized category names based on Accept-Language header. Under a logistics (location) parent requires read:locations; elsewhere requires read:categories.

Parametre

Navn	I	Type
`categoryid` *	path	integer (int64)
`org` *	path	string
`parentcategory` *	path	string

Svar

Status	Innhold
`200`	`application/json` — CategoryDto

PUTUpdate category information. Updates under a logistics (location) parent require write:locations; elsewhere require write:categories.

Parametre

Navn	I	Type
`categoryid` *	path	integer (int64)
`org` *	path	string
`parentcategory` *	path	string

Forespørselskropp *

application/json — UpdateCategoryDto

Svar

Status	Innhold
`400`	–
`409`	–

DELETERemove a category. Deletes under a logistics (location) parent require write:locations; elsewhere require write:categories.

Parametre

Navn	I	Type
`categoryid` *	path	integer (int64)
`org` *	path	string
`parentcategory` *	path	string

Svar

Status	Innhold
`200`	`application/json` — map av integer (int64)

`/{org}/category/{parentcategory}/{parentcategoryid}`

POSTAdd a new subcategory to a database parent category by ID. Under a logistics (location) parent requires write:locations; elsewhere requires write:categories.

Parametre

Navn	I	Type
`org` *	path	string
`parentcategory` *	path	string
`parentcategoryid` *	path	integer (int64)

Forespørselskropp *

application/json — AddCategoryDto

Svar

Status	Innhold
`400`	–
`409`	–

Emission Factor Resource

`/emission-factors/spend`

GETList spend-based emission factors

The complete set of configured spend-based (economic-intensity) emission factors, in configured order, not paginated, filtered or sorted. `perUnit` is already inflated to the band's midpoint and MUST NOT be multiplied by any further uncertainty factor. Answers an empty array where no factor is configured.

Svar

Status	Innhold
`200`	`application/json` — liste av SpendFactorDto

`/emission-factors/spend/{id}`

GETGet one spend-based emission factor

One configured spend-based (economic-intensity) emission factor by id. `perUnit` is already inflated to the band's midpoint and MUST NOT be multiplied by any further uncertainty factor.

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	string

Svar

Status	Innhold
`200`	`application/json` — SpendFactorDto
`404`	–

Entitlement Resource

`/{org}/entitlement`

GETList what the organization has bought, per app

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — liste av EntitlementDto
`403`	–
`404`	–

`/{org}/entitlement/{appId}`

PUTSet the organization's plan for one app

Parametre

Navn	I	Type	Beskrivelse
`appId` *	path	string
`org` *	path	string

Forespørselskropp *

application/json — UpdateEntitlementDto

Svar

Status	Innhold
`200`	`application/json` — EntitlementDto
`400`	–
`403`	–
`404`	–

Instance reports

`/{org}/report/solution/{id}/instance`

POSTCalculate an instance report (HTML)

The same report rendered, in the language negotiated from Accept-Language (en, no), stating the subject/reference header and every applied override as an instance-specific assumption.

Parametre

Navn	I	Type
`id` *	path	integer (int64)
`org` *	path	string
`type`	query	objekt

Forespørselskropp *

application/json — InstanceReportRequestDto

Svar

Status	Innhold
`200`	`application/json` — objekt `application/pdf` `text/html`
`400`	–
`401`	–
`403`	–
`404`	–
`429`	–
`503`	–

`/{org}/report/solution/{id}/parameters`

GETList a solution's keyed flows as parameters

Every flow the solution's author marked variable, in declaration order, so a consumer can render one control per parameter without knowing the shape of a product system. Not rate limited: a single database read spending no third-party quota.

A parameter that is substituted by choosing a category — variability SUBSTITUTABLE, flowType RESOURCE, and stating a defaultReferenceId — also states substitutes: the categories a subsequent specification write would accept in its place, drawn from the modelled reference's own subtree (excluding the reference itself), restricted to the organizations the caller's tenant may read, and filtered by the very selection the instance-report write path applies — so this listing cannot offer a choice the write then refuses with 400. Each entry states id, the localized name and the declaredUnit of the emission factor the calculation would select, ordered by name for the negotiated language, flat and unpaginated.

Absent and empty mean different things: an absent substitutes means this parameter is not substituted by choosing a category at all (a TRANSPORT parameter is substituted by stating a leg, and nothing else is substitutable), while [] means it is, and nothing currently qualifies — including where the modelled reference no longer resolves, which is reported as 'nothing to offer' rather than as an error.

Candidates additionally require read:categories (read:locations for a node in the logistics namespace) on the organization owning the candidate, which is the same gate the instance-report request enforces when it resolves the chosen category. A caller without it is offered fewer candidates, or none — the list is a subset of what this caller may actually use, never a superset.

substitutesRestricted says whether that gate cut the list, so an empty substitutes is never ambiguous. It is present exactly where substitutes is, giving three states in all: absent — this parameter is not substituted by choosing a category; false — the list is complete; true — at least one category that would otherwise have been offered was withheld because the caller may not read it. It states nothing further: not which categories were withheld, not how many, not whose. true alongside a non-empty list means that list is short, not which entries are missing from it, and it is a fact about this parameter's subtree rather than a claim about the caller's account.

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — objekt
`401`	–
`403`	–
`404`	–

Invitation Resource

`/invitation/{invitationId}`

GETGet Invitation

Parametre

Navn	I	Type	Beskrivelse
`invitationId` *	path	UUID

Svar

Status	Innhold
`200`	`application/json` — InvitationDto

`/invitation/{invitationId}/accept`

POSTAccept Invitation

Parametre

Navn	I	Type	Beskrivelse
`invitationId` *	path	UUID

Svar

Status	Innhold
`200`	`application/json` — objekt

Order reports

`/{org}/report/order`

POSTCalculate an order report (JSON only)

An order's lines, priced together with the order-level transport legs calculated from the order's pickup, delivery and the organization's own address, by one default road mode, and returned as one JSON document. Nothing is persisted: the report is the response, and repeating the request repeats the calculation. Once admitted, the answer is always 200 — a per-line or per-leg failure is reported inside the body, never as a whole-call 404 or 503. Rate limited to 20 requests per minute and 100 per hour per token subject, the same instance-reports bucket the instance endpoint draws from, consumed once per call regardless of line count, and only after every whole-call refusal has already been ruled out.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string	The tenant organization
`type`	query	objekt	The report type, applied per line, defaulting to CFP

Forespørselskropp *

application/json — OrderReportRequestDto

Svar

Status	Innhold
`200`	`application/json` — objekt
`400`	–
`401`	–
`403`	–
`429`	–

Organization Admin Resource

`/`

GETGet list of all organizations the user has access to

Parametre

Navn	I	Type	Beskrivelse
`permission`	query	Permission

Svar

Status	Innhold
`200`	`application/json` — liste av OrganizationDto1

POSTCreate a new organization for the authenticated user

Forespørselskropp *

application/json — CreateOrganizationDto

Svar

Status	Innhold
`200`	`application/json` — objekt
`400`	–

`/{org}`

GETGet an organization. Returns a public view (name, description, website, contact email) for unauthenticated or unauthorized users when the organization has enabled public org info.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — OrganizationDto1

PUTUpdate an organization. All fields must be provided in the PUT request

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — UpdateOrganizationDto

Svar

Status	Innhold
`200`	`application/json` — OrganizationDto1
`400`	–

`/{org}/billing`

PUTUpdate an organization's subscription and invoicing

Replaces the organization's subscription level, billing address (invoicing), and functional add-ons. All three fields are written atomically; omit a field to clear it. Subscription and billing are not affected by PUT /{org} — this is the only endpoint that mutates them. Requires WRITE_ORGANIZATION.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — UpdateOrganizationBillingDto

Svar

Status	Innhold
`200`	`application/json` — OrganizationDto1
`400`	–

`/{org}/invite`

POSTInvite a user to the organization via magic link

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — CreateInvitationDto

Svar

Status	Innhold
`200`	`application/json` — objekt
`400`	–

`/{org}/signup`

POSTAdd or reactivate an app's entitlement for an existing organization, granting the acting admin exactly that plan's own conferred permissions

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — SignupExistingOrgDto

Svar

Status	Innhold
`200`	`application/json` — EntitlementDto
`400`	–
`401`	–
`403`	–
`404`	–
`409`	–
`429`	–

`/{org}/stats`

GETGet statistics for the organization

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — OrganizationStatsDto

Organization logo

`/{org}/logo`

POSTUpload (or replace) an organization's logo

Accepts a JPEG or a PNG, identified by its leading bytes rather than by the part's declared content type, up to the configured maximum. The image is submitted to the image classification service before it is stored: an image that is blocked, unreadable or could not be checked is not stored at all, and the objects written for it are removed. A second upload replaces the first; the objects behind the replaced logo are removed on a best-effort basis. Rate limited, consumed after authorization.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

multipart/form-data — object

Svar

Status	Innhold
`201`	–
`400`	–
`401`	–
`403`	–
`404`	–
`413`	–
`422`	–
`429`	–
`503`	–

DELETEDelete an organization's logo

Removes the organization's logo, then the original and both thumbnail objects on a best-effort basis. A repeated delete, or a delete on an organization with no logo, is not an error: it also answers 204.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Svar

Status	Innhold
`204`	–
`401`	–
`403`	–
`404`	–

Products

`/{org}/product`

GETList all products

Supports geographic filtering via filter query parameter. Example: ?filter={"minLat":59.0,"maxLat":60.0,"minLon":10.0,"maxLon":11.0}

Parametre

Navn	I	Type
`org` *	path	string
`filter`	query	string
`range`	query	string

Svar

Status	Innhold
`200`	`application/json` — liste av ProductSystemDto

POSTCreate a new product

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — ProductSystemDto

Svar

Status	Innhold
`200`	`application/json` — ProductSystemDto
`400`	–

`/{org}/product/{id}`

GETGet a product by ID

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — ProductSystemDto

PUTUpdate a product

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Forespørselskropp *

application/json — ProductSystemDto

Svar

Status	Innhold
`200`	`application/json` — ProductSystemDto
`400`	–

DELETEDelete a product

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — map av integer (int64)

Providers Resource

`/providers`

GETGet all public providers

Returns organizations that have at least one public solution. Supports optional name search (case-insensitive, minimum 2 characters). Pagination supported via pageNumber/pageSize query parameters. Rate limited: 50 requests/minute, 200 requests/hour per IP. Cached for 5 minutes.

Parametre

Navn	I	Type
`name`	query	string
`pageNumber`	query	integer (int32)
`pageSize`	query	integer (int32)

Svar

Status	Innhold
`200`	`application/json` — liste av PublicProviderDto
`400`	–
`429`	–

Public Categories Resource

`/categories`

GETGet global RDF-S category taxonomy

Returns the complete public category taxonomy without requiring authentication or organization context. Supports localization via Accept-Language header (en, nb). Rate limited: 50 requests/minute, 200 requests/hour per IP. Cached for 5 minutes.

Svar

Status	Innhold
`200`	`application/json` — TaxonomyDto
`429`	–

Public Reports

`/{org}/report/solution/{id}`

GETGenerate a report for a given solution (service or product)

Authenticated requests may access private solutions; unauthenticated requests are restricted to public solutions. The report is produced in the language negotiated from the Accept-Language header (en, no; defaults to en) — its prose and its category names alike. Data is reproduced as authored: organization names, solution descriptions and cited data sources are not translated. The response states what it resolved in Content-Language and varies on Accept-Language. Rate limited to 20 requests per minute and 100 per hour per IP address.

Parametre

Navn	I	Type
`id` *	path	integer (int64)
`org` *	path	string
`format`	query	objekt
`type`	query	objekt

Svar

Status	Innhold
`200`	`application/json`

Report Qualifications Resource

`/report/qualifications`

GETList selectable report qualifications

The assumptions and limitations a CFP report may declare, each a stable code and its rendering. Negotiates Accept-Language (en, no) against the same message bundle the report is composed from, so the editor and the report cannot disagree about what a code says. The list changes only on deploy and is safe to cache, but it varies by language — Vary: Accept-Language.

Svar

Status	Innhold
`200`	`application/json` — objekt

Services

`/{org}/service`

GETList all services

Supports geographic filtering via filter query parameter. Example: ?filter={"minLat":59.0,"maxLat":60.0,"minLon":10.0,"maxLon":11.0}

Parametre

Navn	I	Type
`org` *	path	string
`filter`	query	string
`range`	query	string

Svar

Status	Innhold
`200`	`application/json` — liste av ProductSystemDto

POSTCreate a new service

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — ProductSystemDto

Svar

Status	Innhold
`200`	`application/json` — ProductSystemDto
`400`	–

`/{org}/service/public`

GETList public services

Returns all services marked as public, optionally filtered by RDFS category. When a category is specified, returns services whose functional unit category is subsumed by (is a subcategory of) the specified category.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`category`	query	string	RDFS category short name (e.g., 'Chair') or full URI to filter by subsumption

Svar

Status	Innhold
`200`	`application/json` — liste av PublicServiceDto

`/{org}/service/{id}`

GETGet a service by external ID

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — ProductSystemDto

PUTUpdate a service

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Forespørselskropp *

application/json — ProductSystemDto

Svar

Status	Innhold
`200`	`application/json` — ProductSystemDto
`400`	–

DELETEDelete a service

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`200`	`application/json` — map av integer (int64)

Site admin

`/site/organizations`

GETList every organization, with member counts and entitlements

Sorted by name, case-insensitively. Unpaginated; X-entries-total equals the array length.

Parametre

Navn	I	Type	Beskrivelse
`app`	query	string	Only organizations holding this app's entitlement, active or not
`q`	query	string	Case-insensitive substring of the name or organization number

Svar

Status	Innhold
`200`	`application/json` — liste av SiteOrganizationDto
`400`	–
`401`	–
`403`	–

`/site/organizations/{id}`

GETOne organization, with its address

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	string

Svar

Status	Innhold
`200`	`application/json` — SiteOrganizationDetailDto
`401`	–
`403`	–
`404`	–

`/site/organizations/{id}/users`

GETEvery membership of one organization

Administrators (WRITE_USERS holders) first, then by email. Includes invitations that have not been accepted, whose sub is null.

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	string

Svar

Status	Innhold
`200`	`application/json` — liste av SiteMemberDto
`401`	–
`403`	–
`404`	–

`/site/users`

GETFind users across every organization

Matches email or name, case-insensitively. Capped at 50 results; X-entries-total is the number of matches before the cap.

Parametre

Navn	I	Type	Beskrivelse
`q` *	query	string	Case-insensitive substring of the email or name; at least 3 characters

Svar

Status	Innhold
`200`	`application/json` — liste av SiteUserDto
`400`	–
`401`	–
`403`	–

Solution images

`/{org}/solution/{id}/image`

POSTUpload an image to a solution

Accepts a JPEG or a PNG, identified by its leading bytes rather than by the part's declared content type, up to the configured maximum and up to ten images per solution. Every image is submitted to the image classification service before it is stored: an image that is blocked, unreadable or could not be checked is not stored at all, and the objects written for it are removed. Rate limited to 10 uploads per minute and 100 per hour per token subject, consumed after authorization.

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Forespørselskropp *

multipart/form-data — object

Svar

Status	Innhold
`201`	–
`400`	–
`401`	–
`403`	–
`404`	–
`413`	–
`422`	–
`429`	–
`503`	–

`/{org}/solution/{id}/image/order`

PUTReorder a solution's images

Takes the complete list of the solution's image ids in the wanted order and answers with the reordered list. A list that omits an image, names an id the solution does not have, or repeats one is refused and the stored order is unchanged.

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)
`org` *	path	string

Forespørselskropp *

application/json — liste av integer (int64)

Svar

Status	Innhold
`200`	`application/json` — liste av SolutionImageDto
`400`	–
`401`	–
`403`	–
`404`	–
`409`	–

`/{org}/solution/{id}/image/{imageId}`

DELETEDelete an image from a solution

Removes the database row first, then the original and both thumbnail objects on a best-effort basis. A storage failure is logged with the orphaned key and does not fail the request. The remaining images keep their relative order, renumbered contiguously from 0.

Parametre

Navn	I	Type
`id` *	path	integer (int64)
`imageId` *	path	integer (int64)
`org` *	path	string

Svar

Status	Innhold
`204`	–
`401`	–
`403`	–
`404`	–

Solutions Resource

`/solutions`

GETGet all public solutions

Returns public solutions (products and services) across all organizations with optional filtering. Supports filtering by type, module, organization, category, and geographic bounds. Category filtering supports three modes via 'categoryMatch' parameter: 'ancestors' (default) searches up the taxonomy (e.g., 'Chair' includes services for 'Furniture'), 'descendants' searches down (e.g., 'Chair' includes 'Office Chair', 'Dining Chair'), 'exact' matches only the specified category. Each solution includes provider location (organization address) and process locations with coordinates for map visualization. Geographic search matches solutions where ANY process location OR organization address falls within the specified bounds. Pagination supported via pageNumber/pageSize query parameters. Rate limited: 50 requests/minute, 200 requests/hour per IP. Cached for 5 minutes.

Parametre

Navn	I	Type
`category`	query	string
`categoryMatch`	query	string
`excludeType`	query	Type6
`maxLatitude`	query	number (double)
`maxLongitude`	query	number (double)
`minLatitude`	query	number (double)
`minLongitude`	query	number (double)
`module`	query	Module1
`organizationIds`	query	string
`pageNumber`	query	integer (int32)
`pageSize`	query	integer (int32)
`type`	query	Type6

Svar

Status	Innhold
`200`	`application/json` — liste av PublicSolutionDto
`429`	–

`/solutions/{id}`

GETGet one public solution by id

Returns a single public solution (isPublic=true) by its id, across all organizations, with the same fields the list endpoint returns. A solution that does not exist and a solution that exists but is not public are indistinguishable: both return 404, so ids cannot be walked to discover private solutions. Rate limited: 100 requests/minute, 500 requests/hour per IP.

Parametre

Navn	I	Type	Beskrivelse
`id` *	path	integer (int64)

Svar

Status	Innhold
`200`	`application/json` — PublicSolutionDto
`404`	–
`429`	–

Taxonomy Resource

`/taxonomies`

GETList available asset taxonomies

Returns the taxonomy library names tenants can list in OrganizationConfigDto.assetTaxonomies. Ordered alphabetically.

Svar

Status	Innhold
`200`	`application/json` — AvailableTaxonomiesDto
`401`	–
`403`	–

Transport Mode Resource

`/transport/modes`

GETList generic transport modes

The GLEC Framework v3.1 generic transport mode catalog with emission factors, sources and assumptions. Mode ids are what a process flow of type TRANSPORT references.

Svar

Status	Innhold
`200`	`application/json` — liste av TransportModeDto

Transport reports

`/{org}/transport/report`

POSTCalculate a transport emission report (JSON)

GLEC/ISO 14083 emissions for one shipment over one chain of legs. Road legs are routed, other modes fall back to great circle, and a stated distanceKm always wins; each leg reports which basis applied. Nothing is stored.

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — TransportReportRequestDto

Svar

Status	Innhold
`200`	`application/json` — TransportReportDto `application/pdf` `text/html`
`400`	–
`401`	–
`403`	–
`429`	–
`503`	–

User Permissions Resource

`/user/permissions`

GETResolve a user's effective permissions for JWT claims

Machine endpoint for sirk-auth-backend. Without `app`, the union across every app; with `app`, permissions and organizations are scoped to that app's subscription (change: app-scoped-user-permissions).

Parametre

Navn	I	Type	Beskrivelse
`app`	query	string	Optional app scope; one of the known app ids, matched case-insensitively. Absent means the unscoped union.
`sub`	query	string

Svar

Status	Innhold
`200`	`application/json` — UserPermissionsResponseDto
`400`	–
`403`	–

User Resource

`/{org}/user`

GETGet all users for a given organization

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`range`	query	string

Svar

Status	Innhold
`200`	`application/json` — liste av UserDto

POSTInvite a user to the organization via magic link

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string

Forespørselskropp *

application/json — AddUserDto

Svar

Status	Innhold
`200`	`application/json` — UserDto
`400`	–

`/{org}/user/{userid}`

GETGet user information

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`userid` *	path	integer (int64)

Svar

Status	Innhold
`200`	`application/json` — UserDto

PUTUpdate user information

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`userid` *	path	integer (int64)

Forespørselskropp *

application/json — UpdateUserDto

Svar

Status	Innhold
`200`	`application/json` — UserDto
`400`	–

DELETERemove a user from the organization

Parametre

Navn	I	Type	Beskrivelse
`org` *	path	string
`userid` *	path	integer (int64)

Svar

Status	Innhold
`200`	`application/json` — map av integer (int64)

Skjemaer

AccessGrantDto

Felt	Type	Beskrivelse
`access`	GrantAccessMap
`createdAt`	LocalDateTime
`id`	integer (int64)
`ownerOrganizationId`	string
`recipientOrganizationId`	string
`recipientOrganizationName`	string
`status`	GrantStatus	Én av: `ACTIVE`, `REVOKED`
`updatedAt`	LocalDateTime

AccessLevel

Én av: read, write

AddApiKeyDto

Felt	Type	Beskrivelse
`description`	string
`expiresAt`	Instant
`name` *	string
`permissions` *	liste av Permission

AddCategoryDto

Felt	Type	Beskrivelse
`categoryProperties`	liste av CategoryPropertyDto
`description`	string
`name` *	string
`parentCategoryId`	integer (int64)

AddUserDto

Felt	Type	Beskrivelse
`email` *	string
`permissions`	liste av Permission

AddressDto

Felt	Type	Beskrivelse
`city`	string
`country`	string
`postalCode`	string
`streetAddress`	string

AddressDto1

An address, with optional coordinates that skip geocoding when both are stated

Felt	Type	Beskrivelse
`address`	string	Required, non-blank, at most 512 characters
`latitude`	number (double)	Degrees, within [-90, 90]
`longitude`	number (double)	Degrees, within [-180, 180]

AddressDto2

Felt	Type	Beskrivelse
`city` *	string
`country` *	string
`geoJson`	GeoJsonObject
`municipality`	string
`municipalityNumber`	string
`postalCode` *	string
`streetAddress`	string

Allocation

Én av: ECONOMIC, BIOPHYSICAL, MASS, SYSTEM_EXPANSION, CUT_OFF, NONE, UNKNOWN

AllocationEntry

Felt	Type	Beskrivelse
`capacity`	AmountDto
`name`	string
`percentage`	number (double)

AllocationsCategoryProperty

Per-location allocation buckets partitioning yearly emissions across capacity dimensions

Felt	Type	Beskrivelse
`entries`	liste av AllocationEntry
`name`	string
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`

Amount

Felt	Type	Beskrivelse
`uncertaintyFactor`	number (double)
`unit`	Unit	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`
`value`	number (double)

AmountDto

Felt	Type	Beskrivelse
`uncertaintyFactor`	number (double)
`unit`	Unit1	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`
`value`	number (double)

ApiKeyDto

Felt	Type	Beskrivelse
`active`	boolean
`clientId`	string
`clientSecret`	string
`createdAt`	Instant
`createdBy`	string
`description`	string
`expiresAt`	Instant
`id`	integer (int64)
`lastUsedAt`	Instant
`name`	string
`permissions`	liste av Permission

ApiKeyPermissionsResponseDto

Felt	Type	Beskrivelse
`active`	boolean
`expiresAt`	Instant
`organization`	string
`permissions`	liste av string

AppliedOverrideDto

One override that actually changed something

Felt	Type	Beskrivelse
`distanceBasis`	DistanceBasis	How a transport override's distance was established Én av: `CALLER_STATED`, `ROUTED`, `GREAT_CIRCLE`, `AS_MODELLED`
`key`	string
`kind`	OverrideKind	What an applied override actually changed Én av: `EXCLUDED`, `AMOUNT`, `SUBSTITUTED`, `TRANSPORT`
`summary`	string

Asset

Felt	Type	Beskrivelse
`address`	string
`allocation`	ImpactAllocation
`buildDate`	LocalDate
`description`	string
`id`	string
`type`	Type4	Én av: `BUILDING`, `MACHINE`

AssetValueCategoryProperty

Asset value property (formuesverdi): a list of per-year valuation entries in NOK

Felt	Type	Beskrivelse
`entries`	liste av AssetValueEntry
`name`	string
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`

AssetValueEntry

Felt	Type	Beskrivelse
`value`	number (double)
`year`	integer (int32)

AvailableTaxonomiesDto

Felt	Type	Beskrivelse
`taxonomies`	liste av AvailableTaxonomyDto

AvailableTaxonomyDto

Felt	Type	Beskrivelse
`name`	string
`rootClassNames`	liste av string

CargoType

What the leg carries; drives the EN 15804 module default

Én av: FUNCTIONAL_UNIT, RESOURCES, WASTE

CategoryDto

Felt	Type	Beskrivelse
`categoryProperties`	liste av CategoryPropertyDto
`description`	string
`displayName`	string
`global`	boolean
`id`	integer (int64)
`name`	string
`organizationId`	string
`parentCategoryDisplayName`	string
`parentCategoryId`	integer (int64)
`parentCategoryName`	string
`uri`	string

CategoryIndicator

Felt	Type	Beskrivelse
`characterizationModel`	Characterization
`name`	string

CategoryPropertyDto

object

Characterization

object

Co2eDataDto

Felt	Type	Beskrivelse
`calculatedAt`	Instant
`impactCategory`	string
`quality`	FigureQualityDto
`savings`	number
`status`	Status	Én av: `PENDING`, `COMPLETED`, `SKIPPED`, `FAILED`
`total`	number
`unit`	string

Co2eSplitDto

CO2e in kg, split well-to-wheel = tank-to-wheel + well-to-tank

Felt	Type	Beskrivelse
`ttwKg`	number (double)
`wttKg`	number (double)
`wtwKg`	number (double)

Code

Why this note was added

Én av: CUSTOMER_HANDLES_TRANSPORT, NO_PICKUP, NO_DELIVERY

Code1

Why a leg could not be priced

Én av: PROVIDER_NOT_PLACED, PICKUP_NOT_PLACED, DELIVERY_NOT_PLACED, ROUTE_UNAVAILABLE, MAP_PROVIDER_UNAVAILABLE, UNKNOWN_MODE, MASS_UNKNOWN

Comparison

Felt	Type	Beskrivelse
`description`	string
`expectedServiceLife`	integer (int32)
`impactCategoryName`	string
`output`	Output

ComponentEntry

Felt	Type	Beskrivelse
`amount`	AmountDto
`categoryId`	integer (int64)

ConsistsOfCategoryProperty

Bill-of-materials property: list of component category references with amounts

Felt	Type	Beskrivelse
`components`	liste av ComponentEntry
`name`	string
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`

ContributionDto

One line's contribution to a leg's mass

Felt	Type	Beskrivelse
`basis`	ContributionMassBasis	Én av: `FUNCTIONAL_UNIT`, `UNKNOWN`
`cargoMassKgPerUnit`	number (double)	Kilograms per functional unit
`lineNumber`	integer (int32)
`massKg`	number (double)	Kilograms; quantity * cargoMassKgPerUnit
`quantity`	integer (int32)	A count of functional units

ContributionMassBasis

Én av: FUNCTIONAL_UNIT, UNKNOWN

CreateAccessGrantDto

Felt	Type	Beskrivelse
`access` *	GrantAccessMap
`recipientOrganizationId` *	string

CreateInvitationDto

Felt	Type	Beskrivelse
`email` *	string
`permissions`	liste av Permission

CreateOrganizationDto

Felt	Type	Beskrivelse
`address`	AddressDto2
`config`	OrganizationConfigDto
`description`	string
`name` *	string
`organizationNumber` *	string
`services`	liste av ServiceDto
`subscriptionLevel`	string
`vatRegistered`	boolean

Crs

Felt	Type	Beskrivelse
`properties`	map av objekt
`type`	CrsType	Én av: `name`, `link`

CrsType

Én av: name, link

DataSource

Felt	Type	Beskrivelse
`dataQuality`	Quality	Én av: `PUBLIC_AUTHORITY_CERTIFIED`, `INTERNAL_CALCULATED`, `NON_PROFIT_AUDITED`, `THIRD_PARTY_REVIEWED`, `UNVERIFIED_AGGREGATION`, `AMOUNT_BASED_ESTIMATE`, `ESTIMATE`
`source`	string
`uncertaintyFactor`	number (double)

DataSourceDto

Felt	Type	Beskrivelse
`dataQuality`	Quality	Én av: `PUBLIC_AUTHORITY_CERTIFIED`, `INTERNAL_CALCULATED`, `NON_PROFIT_AUDITED`, `THIRD_PARTY_REVIEWED`, `UNVERIFIED_AGGREGATION`, `AMOUNT_BASED_ESTIMATE`, `ESTIMATE`
`geographicalCoverage`	string	Geographical coverage of the data, per ISO 14044 §4.2.3.6.2. Free text, because published coverage is routinely a region, a trade mix or a route ("Australia to Rotterdam") rather than a single country.
`referenceYear`	integer (int32)	Reference year of the data — the time-related coverage of the same clause.
`source`	string

DeprecationMethod

Én av: LINEAR

Direction

Whether the leg is arrival transport (a process input) or departure transport (a process output)

Én av: ARRIVAL, DEPARTURE

DisclosureDto

What the report does not count, and what its figures rest on

Felt	Type	Beskrivelse
`criticallyReviewed`	boolean
`distanceAdjustmentApplied`	boolean
`distanceAdjustmentNotes`	liste av string
`excludedFromBoundary`	liste av string
`greatCircleLegLabels`	liste av string
`massBasis`	MassBasis	Én av: `STATED`, `DERIVED_FROM_DENSITY`

DistanceBasis

How a transport override's distance was established

Én av: CALLER_STATED, ROUTED, GREAT_CIRCLE, AS_MODELLED

DistanceBasis1

Én av: CALLER_STATED, ROUTED, GREAT_CIRCLE

EmissionCategoryProperty

Emission category property holding a list of per-LCA-module CO2e entries

Felt	Type	Beskrivelse
`entries`	liste av EmissionEntry
`name`	string
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`

EmissionEntry

Felt	Type	Beskrivelse
`allocation`	Allocation	Én av: `ECONOMIC`, `BIOPHYSICAL`, `MASS`, `SYSTEM_EXPANSION`, `CUT_OFF`, `NONE`, `UNKNOWN`
`dataSource`	DataSourceDto
`declaredUnit`	Unit1	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`
`description`	string
`kgEmissionPerUnit`	number (double)
`module`	LcaModule	Én av: `A1`, `A2`, `A3`, `A1_A3`, `A4`, `A5`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `C1_C4`, `D`, `CRADLE_TO_GRAVE`, `CRADLE_TO_GATE`
`type`	Type7	Én av: `CH4_NON_FOSSIL`, `N2O`, `SF6`, `NF3`, `CH4_FOSSIL`, `CO2E`, `CO2`

EndpointDto

One end of a leg: an address, a point, or both

Felt	Type	Beskrivelse
`address`	string
`latitude`	number (double)
`longitude`	number (double)

EndpointOverrideDto

One end of a restated leg: a location category id, or an address with optional coordinates — never both

Felt	Type	Beskrivelse
`address`	string
`latitude`	number (double)
`locationId`	integer (int64)
`longitude`	number (double)

EnergyMixCategoryProperty

Energy mix property: list of energy sources with CO2e factors per unit

Felt	Type	Beskrivelse
`name`	string
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`
`yearlyEnergySources`	liste av EnergySourceEntry

EnergySource

Én av: NO_STANDARD, EU_AVERAGE, SOLAR, WIND, HYDROELECTRIC, NATURAL_GAS, OIL_FUEL, DISTRICT_HEATING, BIOMASS

EnergySourceEntry

Felt	Type	Beskrivelse
`amount`	AmountDto
`kgCo2ePerUnit`	number (double)
`source`	EnergySource	Én av: `NO_STANDARD`, `EU_AVERAGE`, `SOLAR`, `WIND`, `HYDROELECTRIC`, `NATURAL_GAS`, `OIL_FUEL`, `DISTRICT_HEATING`, `BIOMASS`

EntitlementDto

Felt	Type	Beskrivelse
`active`	boolean
`app`	string
`plan`	string
`source`	Source	Én av: `PURCHASED`, `INCLUDED`
`updatedAt`	Instant

EnumOptionDto

Felt	Type	Beskrivelse
`attributes`	map av string
`description`	string
`jurisdiction`	string
`labelEn`	string
`labelNo`	string
`notation`	string
`value`	string

FORMAT

Én av: HTML, PDF

FactorDto

Felt	Type	Beskrivelse
`assumptions`	string
`effectiveKgCo2ePerTkm`	number (double)
`gridFactorGCo2ePerKwh`	number (double)
`gridFactorSource`	string
`kwhPerTkm`	number (double)
`sourceReference`	string
`tonnesPerTeu`	number (double)
`ttwKgPerUnit`	number (double)
`unit`	string
`wttKgPerUnit`	number (double)
`wtwKgPerUnit`	number (double)

FigureQualityDto

Felt	Type	Beskrivelse
`dataQuality`	string
`errorMargin`	number (double)
`source`	string

Flow

object

FlowConfig

Felt	Type	Beskrivelse
`amount`	Amount
`id`	string
`module`	Module	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`placeholder`	boolean
`type`	Type3	Én av: `ASSET`, `RESOURCE`, `RELEASE`, `FUNCTIONAL_UNIT`

FlowDto

Felt	Type	Beskrivelse
`allocationName`	string
`amount`	AmountDto
`description`	string
`key`	string	An author-assigned identifier, unique across the whole solution, that an instance report may address this flow by. Must match ^[a-z0-9-]{1,40}$. A flow with no key is not addressable and is always calculated as modelled.
`origin`	string	Whether a RESOURCE input is virgin or recovered material. Absent means VIRGIN, which is what every flow stored before this member existed means. Applies only to a RESOURCE flow among a process's inputs; a RECOVERED input enters the product system burden-free under the EN 15804 cut-off approach for secondary material. Én av: `VIRGIN`, `RECOVERED`
`referenceId`	integer (int64)
`transport`	TransportFlowDto
`type`	Type5	Én av: `RESOURCE`, `ASSET_TIME`, `LOCATION_TIME`, `LOCATION_ALLOCATION`, `FUNCTIONAL_UNIT`, `EMISSION`, `WASTE`, `LOSS`, `TRANSPORT`
`variability`	Variability	Én av: `FIXED`, `OPTIONAL`, `SUBSTITUTABLE`

FreightDto

The goods moved over the chain

Felt	Type	Beskrivelse
`densityKgPerM3`	number (double)
`grossMassKg`	number (double)
`name`	string
`type` *	FreightType	Whether the shipment fills the vehicle on mass or on space Én av: `MASS_LIMITED`, `VOLUME_LIMITED`
`volumeM3`	number (double)

FreightResultDto

The shipment, and how its mass was established

Felt	Type	Beskrivelse
`densityKgPerM3`	number (double)
`massBasis`	MassBasis	Én av: `STATED`, `DERIVED_FROM_DENSITY`
`massKg`	number (double)
`name`	string
`type`	Type9	Én av: `MASS_LIMITED`, `VOLUME_LIMITED`
`volumeM3`	number (double)

FreightType

Whether the shipment fills the vehicle on mass or on space

Én av: MASS_LIMITED, VOLUME_LIMITED

Function

Felt	Type	Beskrivelse
`description`	string
`functionalUnit`	FunctionalUnit
`id`	string
`performanceCharacteristics`	liste av PerformanceCharacteristic

FunctionalAddOn

Én av: SERVICE_PROVIDER, ORDER, C02_CALCULATIONS, EXTERNAL_INTEGRATION

FunctionalUnit

Felt	Type	Beskrivelse
`accumulatedReleases`	liste av Release
`amount`	Amount
`category`	string
`description`	string
`id`	string
`type`	Type	Én av: `PRODUCTION`, `SERVICE`

FunctionalUnitDto

Felt	Type	Beskrivelse
`amount`	number (double)
`categoryId`	integer (int64)
`expectedServiceLife`	integer (int32)
`massKg`	number (double)
`unit`	Unit1	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`

FunctionalUnitJson

Felt	Type	Beskrivelse
`amount`	AmountDto
`categoryId`	integer (int64)
`expectedServiceLife`	integer (int32)
`massKg`	number (double)

GeoJsonObject

Felt	Type	Beskrivelse
`bbox`	liste av number (double)
`crs`	Crs

Goal

Felt	Type	Beskrivelse
`audience`	string
`compareTo`	Comparison
`intendedApplication`	string
`reason`	string
`usedInComparativeAssessment`	boolean

GrantAccessMap

Felt	Type	Beskrivelse
`assets`	AccessLevel	Én av: `read`, `write`
`categories`	AccessLevel	Én av: `read`, `write`
`empty`	boolean
`locations`	AccessLevel	Én av: `read`, `write`

GrantStatus

Én av: ACTIVE, REVOKED

ImpactAllocation

Felt	Type	Beskrivelse
`deprecationMethod`	DeprecationMethod	Én av: `LINEAR`
`description`	string
`directPerHourKgCO2e`	number (double)
`endOfLifeImpactKgCO2eTotal`	number (double)
`lifetimeHours`	integer (int64)
`maintenanceImpactKgCO2eTotal`	number (double)
`onCreationImpactKgCO2eTotal`	number (double)
`source`	DataSource

ImpactCategory

Felt	Type	Beskrivelse
`categoryIndicator`	CategoryIndicator
`name`	string

IncomingGrantDto

Felt	Type	Beskrivelse
`access`	GrantAccessMap
`ownerOrganizationId`	string
`ownerOrganizationName`	string

InstanceReportDto

A solution's carbon footprint report, recalculated for one specific object

Felt	Type	Beskrivelse
`appliedOverrides`	liste av AppliedOverrideDto
`calculatedAt`	Instant
`functionalUnit`	FunctionalUnitDto
`impactCategory`	string
`language`	string
`quality`	FigureQualityDto
`reference`	string
`report`	ReportDto
`solutionId`	integer (int64)
`solutionName`	string
`subject`	SubjectDto	What the report is a footprint of, printed on it
`totalPerUnit`	Total

InstanceReportRequestDto

A solution's report recalculated for one specific object

Felt	Type	Beskrivelse
`overrides`	liste av OverrideDto
`reference`	string
`subject`	SubjectDto	What the report is a footprint of, printed on it

Instant

string (date-time)

InvitationDto

Felt	Type	Beskrivelse
`invitationId`	UUID
`inviteeEmail`	string
`organizationId`	string
`organizationName`	string
`permissions`	liste av Permission
`status`	UserOrganizationStatus	Én av: `INVITED`, `ACTIVE`

LcaModule

Én av: A1, A2, A3, A1_A3, A4, A5, B1, B2, B3, B4, B5, B6, B7, C1, C2, C3, C4, C1_C4, D, CRADLE_TO_GRAVE, CRADLE_TO_GATE

LegDto

One leg of the transport chain

Felt	Type	Beskrivelse
`destination` *	EndpointDto	One end of a leg: an address, a point, or both
`distanceKm`	number (double)
`label`	string
`modeId` *	string
`origin` *	EndpointDto	One end of a leg: an address, a point, or both

LegEndpointDto

One transport leg endpoint, as resolved

Felt	Type	Beskrivelse
`address`	string
`geocoded`	boolean
`latitude`	number (double)	Degrees
`longitude`	number (double)	Degrees
`name`	string
`role`	Role	Whose end of the leg this endpoint is Én av: `PICKUP`, `DELIVERY`, `PROVIDER`

LegReasonDto

Why an order-level transport leg could not be priced

Felt	Type	Beskrivelse
`code`	Code1	Why a leg could not be priced Én av: `PROVIDER_NOT_PLACED`, `PICKUP_NOT_PLACED`, `DELIVERY_NOT_PLACED`, `ROUTE_UNAVAILABLE`, `MAP_PROVIDER_UNAVAILABLE`, `UNKNOWN_MODE`, `MASS_UNKNOWN`
`message`	string

LegResultDto

One leg's distance, activity, emissions and factor

Felt	Type	Beskrivelse
`activityMode`	string
`co2e`	Co2eSplitDto	CO2e in kg, split well-to-wheel = tank-to-wheel + well-to-tank
`destination`	ResolvedEndpointDto	A leg endpoint and the point it resolved to
`distanceBasis`	DistanceBasis1	Én av: `CALLER_STATED`, `ROUTED`, `GREAT_CIRCLE`
`distanceKm`	number (double)
`factor`	FactorDto
`label`	string
`mapImage`	string
`modeId`	string
`modeName`	string
`origin`	ResolvedEndpointDto	A leg endpoint and the point it resolved to
`routeGeometry`	RouteGeometryDto	The path the distance was measured along
`tonneKm`	number (double)

LifeCycleAssessment

Felt	Type	Beskrivelse
`goal`	Goal
`id`	string
`methodology`	Methodology	Én av: `ISO14044`, `UNKNOWN`
`scope`	Scope

LineDto

One order line: a quantity of a solution, plus any per-line overrides

Felt	Type	Beskrivelse
`lineNumber`	integer (int32)
`overrides`	liste av OverrideDto
`quantity`	integer (int32)	A count of functional units
`solutionId`	integer (int64)

LineErrorDto

Why one order line could not be calculated

Felt	Type	Beskrivelse
`code`	string
`message`	string

LineResultDto

One order line's result: a figure, or why it has none

Felt	Type	Beskrivelse
`error`	LineErrorDto	Why one order line could not be calculated
`lineNumber`	integer (int32)
`lineTotalKg`	number (double)	Kilograms CO2e; report.totalPerUnit.value * quantity
`quantity`	integer (int32)	A count of functional units
`report`	InstanceReportDto	A solution's carbon footprint report, recalculated for one specific object
`solutionId`	integer (int64)

LngLatAlt

Felt	Type	Beskrivelse
`additionalElements`	liste av number (double)
`altitude`	number (double)
`latitude`	number (double)
`longitude`	number (double)

LocalDate

string (date)

LocalDateTime

string (date-time)

MassBasis

Én av: STATED, DERIVED_FROM_DENSITY

Methodology

Én av: ISO14044, UNKNOWN

Module

Én av: A1, A2, A3, A4, A5, CRADLE_TO_GATE, B1, B2, B3, B4, B5, B6, B7, C1, C2, C3, C4, D, CRADLE_TO_GRAVE

Module1

Én av: A1, A2, A3, A4, A5, CRADLE_TO_GATE, B1, B2, B3, B4, B5, B6, B7, C1, C2, C3, C4, D, CRADLE_TO_GRAVE

MultiCategoryProperty

Multi-category property: a list of category references constrained to a target root class

Felt	Type	Beskrivelse
`categoryIds`	liste av integer (int64)
`name`	string
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`targetRootClass`	string
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`

OrderLegDto

One order-level transport leg: an ARRIVAL or DEPARTURE priced (or failed) between the order's own address and the organization's own address

Felt	Type	Beskrivelse
`activityMode`	string
`cargoMassKg`	number (double)	Kilograms
`co2e`	Co2eSplitDto	CO2e in kg, split well-to-wheel = tank-to-wheel + well-to-tank
`co2eKg`	number (double)	Kilograms CO2e; equal to co2e.wtwKg
`contributions`	liste av ContributionDto
`direction`	Direction	Whether the leg is arrival transport (a process input) or departure transport (a process output) Én av: `ARRIVAL`, `DEPARTURE`
`distanceBasis`	DistanceBasis1	Én av: `CALLER_STATED`, `ROUTED`, `GREAT_CIRCLE`
`distanceKm`	number (double)	Kilometres
`factor`	FactorDto
`from`	LegEndpointDto	One transport leg endpoint, as resolved
`modeId`	string
`modeName`	string
`reason`	LegReasonDto	Why an order-level transport leg could not be priced
`status`	OrderLegStatus	Én av: `PRICED`, `FAILED`
`to`	LegEndpointDto	One transport leg endpoint, as resolved
`tonneKm`	number (double)	Tonne-kilometres; cargoMassKg / 1000 * distanceKm

OrderLegStatus

Én av: PRICED, FAILED

OrderReportDto

An order's per-line footprints, order-level transport legs and total, none of it persisted

Felt	Type	Beskrivelse
`calculatedAt`	Instant
`catalogVersion`	string
`language`	string
`lines`	liste av LineResultDto
`reference`	string
`subject`	SubjectDto	What the report is a footprint of, printed on it
`total`	TotalDto	The order's total, in kg CO2e
`transport`	liste av OrderLegDto
`transportDisclosure`	DisclosureDto	What the report does not count, and what its figures rest on
`transportNotes`	liste av TransportNoteDto

OrderReportRequestDto

An order's lines and addresses; transport legs are calculated from pickup, delivery and the organization's own address

Felt	Type	Beskrivelse
`customerHandlesTransport`	boolean
`delivery`	AddressDto1	An address, with optional coordinates that skip geocoding when both are stated
`lines`	liste av LineDto
`pickup`	AddressDto1	An address, with optional coordinates that skip geocoding when both are stated
`reference`	string
`subject`	SubjectDto	What the report is a footprint of, printed on it

OrganizationBillingDto

Felt	Type	Beskrivelse
`addOns`	liste av FunctionalAddOn
`billingAddress`	AddressDto2

OrganizationConfigDto

Felt	Type	Beskrivelse
`approvedServiceProviders`	liste av string
`assetTaxonomies`	liste av string
`billing`	OrganizationBillingDto
`contactEmail`	string
`externalServiceRequestUrl`	string
`jurisdiction`	string
`publicView`	PublicViewConfigDto
`serviceProviderFor`	liste av string
`website`	string

OrganizationDto

Felt	Type	Beskrivelse
`address`	AddressDto
`description`	string
`id`	string
`name`	string
`organizationNumber`	string
`website`	string (uri)

OrganizationDto1

Felt	Type	Beskrivelse
`address`	AddressDto2
`config`	OrganizationConfigDto
`description`	string
`entitlements`	liste av EntitlementDto
`id` *	string
`logo`	OrganizationLogoDto	An organization's logo, with presigned URLs for the original and its 200 px thumbnail
`name` *	string
`organizationNumber`	string
`services`	liste av ServiceDto
`subscriptionLevel`	string
`vatRegistered`	boolean

OrganizationLogoDto

An organization's logo, with presigned URLs for the original and its 200 px thumbnail

Felt	Type	Beskrivelse
`thumbnailUrl`	string	Presigned GET URL for the 200 px thumbnail, valid for 7 days
`url`	string	Presigned GET URL for the original, valid for 7 days

OrganizationStatsDto

Felt	Type	Beskrivelse
`createdAt`	LocalDateTime
`id`	string
`name`	string
`updatedAt`	LocalDateTime
`userCount`	integer (int64)

Origin

Én av: VIRGIN, RECOVERED

Output

Felt	Type	Beskrivelse
`amount`	Amount
`description`	string
`id`	string
`module`	Module	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`source`	Flow

OverrideDto

One override, addressing exactly one of the solution's declared parameters

Felt	Type	Beskrivelse
`amount`	AmountDto
`exclude`	boolean
`key` *	string
`note`	string
`referenceId`	integer (int64)
`transport`	TransportOverrideDto	A restated transport leg; anything not stated keeps its modelled value

OverrideKind

What an applied override actually changed

Én av: EXCLUDED, AMOUNT, SUBSTITUTED, TRANSPORT

ParameterEndpointDto

One end of a keyed transport leg's modelled endpoint

Felt	Type	Beskrivelse
`address`	string
`latitude`	number (double)
`locationId`	integer (int64)
`longitude`	number (double)
`name`	string

ParameterTransportDto

The modelled leg behind a keyed TRANSPORT parameter

Felt	Type	Beskrivelse
`cargoMassKg`	number (double)
`cargoType`	CargoType	What the leg carries; drives the EN 15804 module default Én av: `FUNCTIONAL_UNIT`, `RESOURCES`, `WASTE`
`direction`	Direction	Whether the leg is arrival transport (a process input) or departure transport (a process output) Én av: `ARRIVAL`, `DEPARTURE`
`distanceKm`	number (double)
`from`	ParameterEndpointDto	One end of a keyed transport leg's modelled endpoint
`modeId`	string
`modeName`	string
`module`	Module1	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`to`	ParameterEndpointDto	One end of a keyed transport leg's modelled endpoint

Part

Felt	Type	Beskrivelse
`amount`	Amount
`resourceId`	string

PerformanceCharacteristic

Én av: NUMBER_OF_FUNCTIONAL_UNITS, CO2E_PER_FUNCTIONAL_UNIT

Permission

Én av: READ_ASSETS, WRITE_ASSETS, READ_DEVIATIONS, WRITE_DEVIATIONS, READ_ORGANIZATION, WRITE_ORGANIZATION, READ_USERS, WRITE_USERS, READ_PRODUCTS, WRITE_PRODUCTS, READ_SERVICES, WRITE_SERVICES, EXECUTE_SERVICES, READ_PROCUREMENTS, WRITE_PROCUREMENTS, READ_CATEGORIES, WRITE_CATEGORIES, READ_LOCATIONS, WRITE_LOCATIONS, PUBLISH_REPORTS, PUBLISH_DPP, PUBLISH_MARKETPLACE, READ_LEDGER, WRITE_LEDGER, READ_REGISTRY, WRITE_REGISTRY, SUBMIT_FILINGS, ADMIN_LEDGER, WRITE_VOUCHERS, READ_API_KEYS, WRITE_API_KEYS

Point

Felt	Type	Beskrivelse
`bbox`	liste av number (double)
`coordinates`	LngLatAlt
`crs`	Crs

ProcessClassification

Én av: FOREGROUND, BACKGROUND

ProcessLocationDto

Felt	Type	Beskrivelse
`categoryId`	integer (int64)
`categoryName`	string
`latitude`	number (double)
`longitude`	number (double)
`processName`	string

ProductSystem

Felt	Type	Beskrivelse
`description`	string
`id`	string
`location`	Asset
`machines`	liste av Asset
`organization`	OrganizationDto
`processes`	liste av UnitProcess
`releases`	liste av Release
`resources`	liste av Resource

ProductSystemDto

Felt	Type	Beskrivelse
`address`	string
`co2eData`	Co2eDataDto
`configuratorUrl`	string	Optional link to the site where a customer designs this solution (the Reinventar app links to it from the marketplace card and from an order). Must be an absolute https URL of at most 2048 characters with no query string or fragment; a trailing slash is removed on save. Empty or whitespace-only stores as null.
`description`	string
`functionalUnit`	FunctionalUnitJson
`id`	integer (int64)
`images`	liste av SolutionImageDto	This solution's images, in the provider's chosen order — position 0 is the lead image. Empty, never null, when the solution has none. Both URLs are presigned GET URLs valid for 7 days, freshly generated for this response.
`isPublic`	boolean
`linkGuaranteeConditions`	string
`module`	Module1	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`moreInfoUrl`	string	Optional link to further information about the solution, rendered as a hyperlink on the marketplace and the public report. Must be an absolute http or https URL of at most 2048 characters; any other scheme or a relative reference is refused on save. Empty or whitespace-only stores as null.
`name` *	string
`processes`	liste av UnitProcessDto
`reportConfig`	ReportConfigDto
`type`	Type6	Én av: `RECOVER_VALUE`, `RETAIN_VALUE`, `ADD_VALUE`, `PRODUCTION`
`yearsGuarantee`	integer (int32)

PropertySource

Én av: OWN, INHERITED, OVERRIDDEN, CALCULATED

PropertyType

Én av: STRING, DECIMAL, INTEGER, DATE, BOOLEAN, INTEGER_SCALE_1TO5, DECIMAL_CM, UNIT, DECIMAL_KG, DECIMAL_M2, DECIMAL_M3, CATEGORY, URL, MULTI_CATEGORY, EMAIL_FORM, RESOURCE_TYPE, EMISSION, LAT_LONG, CONSISTS_OF, ENERGY_MIX, ALLOCATIONS, ASSET_VALUE, ADDRESS, GEO_POINT, LOCATION_TYPE, DEPRECIATION_GROUP

PublicProviderDto

Felt	Type	Beskrivelse
`description`	string
`id`	string
`logoUrl`	string
`name`	string
`publicSolutionCount`	integer (int64)

PublicServiceDto

Felt	Type	Beskrivelse
`address`	string
`categoryId`	integer (int64)
`categoryName`	string
`description`	string
`id`	integer (int64)
`module`	Module1	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`name`	string
`organizationId`	string
`organizationName`	string
`type`	Type6	Én av: `RECOVER_VALUE`, `RETAIN_VALUE`, `ADD_VALUE`, `PRODUCTION`

PublicSolutionDto

Felt	Type	Beskrivelse
`address`	string
`categoryId`	integer (int64)
`categoryName`	string
`co2eData`	Co2eDataDto
`configuratorUrl`	string	Optional link to the site where a customer designs this solution, an absolute https URL with no query string, fragment or trailing slash, so a path such as /order/{id} can be appended. Null when the solution set none.
`description`	string
`functionalUnit`	FunctionalUnitDto
`id`	integer (int64)
`images`	liste av SolutionImageDto	This solution's images, in the provider's chosen order — position 0 is the lead image. Empty, never null, when the solution has none. Both URLs are presigned GET URLs valid for 7 days, freshly generated for this response.
`linkGuaranteeConditions`	string
`module`	Module1	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`moreInfoUrl`	string	Optional link to further information about the solution, rendered as a hyperlink on the marketplace card. Null when the solution set none.
`name`	string
`organizationId`	string
`organizationName`	string
`processLocations`	liste av ProcessLocationDto
`product`	boolean
`providerLocation`	Point
`service`	boolean
`type`	Type6	Én av: `RECOVER_VALUE`, `RETAIN_VALUE`, `ADD_VALUE`, `PRODUCTION`
`yearsGuarantee`	integer (int32)

PublicViewConfigDto

Felt	Type	Beskrivelse
`publicOrgInfo`	boolean

Quality

Én av: PUBLIC_AUTHORITY_CERTIFIED, INTERNAL_CALCULATED, NON_PROFIT_AUDITED, THIRD_PARTY_REVIEWED, UNVERIFIED_AGGREGATION, AMOUNT_BASED_ESTIMATE, ESTIMATE

Release

Felt	Type	Beskrivelse
`category`	string
`characterizationFactor`	number (double)
`dataSource`	DataSource
`description`	string
`id`	string
`scope`	Scope1	Én av: `SCOPE_1`, `SCOPE_2`, `SCOPE_3`
`source`	Flow
`unit`	Unit	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`

ReportConfigDto

Felt	Type	Beskrivelse
`methodology`	Methodology	Én av: `ISO14044`, `UNKNOWN`
`reports`	liste av ReportDto1

ReportDto

Felt	Type	Beskrivelse
`comparisons`	liste av Result
`correlationId`	string
`created`	LocalDateTime
`id`	string
`lca`	LifeCycleAssessment
`name`	string
`results`	liste av Result

ReportDto1

Felt	Type	Beskrivelse
`description`	string
`name`	string
`properties`	map av string
`type`	Type10	Én av: `CFP`

ReportQualificationDto

A selectable report qualification: a stable code and its rendering in the negotiated language.

Felt	Type	Beskrivelse
`code`	string	Stable identifier stored on the solution.
`text`	string	The sentence the report will state, in the negotiated language.

ResolvedEndpointDto

A leg endpoint and the point it resolved to

Felt	Type	Beskrivelse
`address`	string
`geocoded`	boolean
`latitude`	number (double)
`longitude`	number (double)

Resource

Felt	Type	Beskrivelse
`category`	string
`consistsOf`	liste av Part
`dataSource`	DataSource
`description`	string
`emissions`	liste av ResourceEmission
`id`	string
`type`	Type1	Én av: `NATURAL_RESOURCE`, `VIRGIN_RESOURCE`, `RECOVERABLE_RESOURCE`, `NON_RECOVERABLE_RESOURCE`, `RECOVERED_RESOURCE`, `ENERGY`, `WASTE`, `LOSS`
`unit`	Unit	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`

ResourceEmission

Felt	Type	Beskrivelse
`description`	string
`kgEmissionPerUnit`	number (double)
`releaseId`	string

Result

Felt	Type	Beskrivelse
`dataSource`	DataSource
`description`	string
`id`	string
`impactCategory`	ImpactCategory
`name`	string
`outputs`	liste av Output
`total`	Output

Role

Whose end of the leg this endpoint is

Én av: PICKUP, DELIVERY, PROVIDER

RouteGeometryDto

The path the distance was measured along

Felt	Type	Beskrivelse
`coordinates`	liste av liste av number (double)
`type`	Type8	Én av: `ROUTED_PATH`, `STRAIGHT_LINE`

Scope

Felt	Type	Beskrivelse
`allocationProcedures`	string
`assumptions`	string
`dataQualityRequirements`	string
`dataRequirements`	string
`expectedServiceLife`	integer (int32)
`function`	Function
`interpretation`	string
`limitations`	string
`methodologyId`	string
`productSystem`	ProductSystem
`reportFormat`	string
`systemBoundary`	string
`typeOfCriticalReview`	string

Scope1

Én av: SCOPE_1, SCOPE_2, SCOPE_3

ServiceDto

Felt	Type	Beskrivelse
`description`	string
`inventoryType`	string
`type`	ServiceType	Én av: `REDESIGN`, `REUPHOLSTER`, `STORAGE`, `MAINTENANCE`, `DISCARD`

ServiceType

Én av: REDESIGN, REUPHOLSTER, STORAGE, MAINTENANCE, DISCARD

SignupExistingOrgDto

Felt	Type	Beskrivelse
`subscriptionLevel` *	string

SimplePropertyValue

Scalar category property (STRING, DECIMAL, INTEGER, BOOLEAN, URL, etc.); CATEGORY carries targetRootClass

Felt	Type	Beskrivelse
`name`	string
`options`	liste av EnumOptionDto
`source`	PropertySource	Én av: `OWN`, `INHERITED`, `OVERRIDDEN`, `CALCULATED`
`targetRootClass`	string
`type`	PropertyType	Én av: `STRING`, `DECIMAL`, `INTEGER`, `DATE`, `BOOLEAN`, `INTEGER_SCALE_1TO5`, `DECIMAL_CM`, `UNIT`, `DECIMAL_KG`, `DECIMAL_M2`, `DECIMAL_M3`, `CATEGORY`, `URL`, `MULTI_CATEGORY`, `EMAIL_FORM`, `RESOURCE_TYPE`, `EMISSION`, `LAT_LONG`, `CONSISTS_OF`, `ENERGY_MIX`, `ALLOCATIONS`, `ASSET_VALUE`, `ADDRESS`, `GEO_POINT`, `LOCATION_TYPE`, `DEPRECIATION_GROUP`
`value`	string

SiteEntitlementDto

Felt	Type	Beskrivelse
`active`	boolean
`app`	string
`plan`	string
`updatedAt`	Instant

SiteMemberDto

Felt	Type	Beskrivelse
`email`	string
`isAdmin`	boolean
`name`	string
`permissions`	liste av string
`status`	UserOrganizationStatus	Én av: `INVITED`, `ACTIVE`
`sub`	string

SiteMembershipDto

Felt	Type	Beskrivelse
`isAdmin`	boolean
`organizationId`	string
`organizationName`	string
`status`	UserOrganizationStatus	Én av: `INVITED`, `ACTIVE`

SiteOrganizationDetailDto

Felt	Type	Beskrivelse
`address`	AddressDto2
`adminCount`	integer (int64)
`createdAt`	LocalDateTime
`entitlements`	liste av SiteEntitlementDto
`name`	string
`organizationId`	string
`organizationNumber`	string
`updatedAt`	LocalDateTime
`userCount`	integer (int64)
`vatRegistered`	boolean

SiteOrganizationDto

Felt	Type	Beskrivelse
`adminCount`	integer (int64)
`createdAt`	LocalDateTime
`entitlements`	liste av SiteEntitlementDto
`name`	string
`organizationId`	string
`organizationNumber`	string
`updatedAt`	LocalDateTime
`userCount`	integer (int64)
`vatRegistered`	boolean

SiteUserDto

Felt	Type	Beskrivelse
`email`	string
`memberships`	liste av SiteMembershipDto
`name`	string
`sub`	string

SolutionImageDto

An image on a solution, with presigned URLs for the original and its 200 px thumbnail

Felt	Type	Beskrivelse
`altText`	string	Alternative text, at most 200 characters; null when the provider set none
`id`	integer (int64)	Stable image id, unique across solutions
`position`	integer (int32)	Zero-based position in the provider's chosen order; 0 is the lead image
`thumbnailUrl`	string	Presigned GET URL for the 200 px thumbnail, valid for 7 days
`url`	string	Presigned GET URL for the original, valid for 7 days

SolutionParameterDto

One keyed flow, published as a parameter an instance report may address

Felt	Type	Beskrivelse
`defaultAmount`	AmountDto
`defaultReferenceId`	integer (int64)
`defaultReferenceName`	string
`flowType`	Type5	Én av: `RESOURCE`, `ASSET_TIME`, `LOCATION_TIME`, `LOCATION_ALLOCATION`, `FUNCTIONAL_UNIT`, `EMISSION`, `WASTE`, `LOSS`, `TRANSPORT`
`key`	string
`label`	string
`origin`	string	Whether a RESOURCE parameter is virgin or recovered material. Stated as VIRGIN or RECOVERED on every parameter whose flowType is RESOURCE — Absent means VIRGIN in the underlying flow, resolved here so a consumer never has to know the default. Absent (this member itself) on every other flowType. A RECOVERED input enters the product system burden-free under the EN 15804 cut-off approach for secondary material, whatever its category holds. Én av: `VIRGIN`, `RECOVERED`
`processName`	string
`substitutes`	liste av SubstituteCandidateDto	The categories a specification write would accept in place of defaultReferenceId. Present only for a SUBSTITUTABLE RESOURCE flow carrying a defaultReferenceId; absent on every other parameter — never an empty list for one of those, which would be indistinguishable from a substitutable parameter whose subtree qualifies nothing
`substitutesRestricted`	boolean	Whether substitutes was cut short by the read gate. Present exactly where substitutes is present, stated as true or false on every such parameter, absent on every other. Absent means this parameter is not substituted by category at all; false means the list is complete; true means at least one usable candidate exists that the caller may not read. This is a per-parameter fact about one subtree, not an account-level claim about the caller's permissions in general
`transport`	ParameterTransportDto	The modelled leg behind a keyed TRANSPORT parameter
`variability`	Variability	Én av: `FIXED`, `OPTIONAL`, `SUBSTITUTABLE`

SolutionParametersDto

A solution's keyed flows, published as a parameter list an instance report may fill in

Felt	Type	Beskrivelse
`functionalUnit`	FunctionalUnitDto
`language`	string
`parameters`	liste av SolutionParameterDto
`solutionId`	integer (int64)
`solutionName`	string
`solutionType`	Type6	Én av: `RECOVER_VALUE`, `RETAIN_VALUE`, `ADD_VALUE`, `PRODUCTION`

Source

Én av: PURCHASED, INCLUDED

SpendFactorDto

Felt	Type	Beskrivelse
`currency`	string
`geographicalCoverage`	string
`id`	string
`perUnit`	ValueDto
`quality`	FigureQualityDto
`rawPerUnit`	ValueDto
`referenceYear`	integer (int32)

Status

Én av: PENDING, COMPLETED, SKIPPED, FAILED

SubjectDto

What the report is a footprint of, printed on it

Felt	Type	Beskrivelse
`identifier`	string
`title`	string

SubscriptionLevelPatch

The plan the organization is on. Omit to leave the subscription unchanged; send null to cancel it; send a plan to set it.

string

SubstituteCandidateDto

One category a substitutable RESOURCE parameter may be swapped for

Felt	Type	Beskrivelse
`declaredUnit`	Unit1	Én av: `KG`, `L`, `M2`, `M3`, `KWH`, `COUNT`, `MINUTES`, `TKM`
`id`	integer (int64)	Category id; negative for a globally shared category, positive for an organization's own
`name`	string	The category's localized display name

TaxonomyDto

Felt	Type	Beskrivelse
`category`	CategoryDto
`children`	liste av TaxonomyDto

Total

Felt	Type	Beskrivelse
`unit`	string
`value`	number (double)

TotalDto

The order's total, in kg CO2e

Felt	Type	Beskrivelse
`co2eKg`	number (double)
`complete`	boolean
`linesKg`	number (double)
`transportKg`	number (double)

TransportEndpointDto

An address endpoint of a transport leg, used where no logistics location applies

Felt	Type	Beskrivelse
`address`	string
`latitude`	number (double)
`longitude`	number (double)

TransportFlowDto

Felt	Type	Beskrivelse
`cargoMassKg`	number (double)
`cargoType`	CargoType	What the leg carries; drives the EN 15804 module default Én av: `FUNCTIONAL_UNIT`, `RESOURCES`, `WASTE`
`distanceKm`	number (double)
`fromAddress`	TransportEndpointDto	An address endpoint of a transport leg, used where no logistics location applies
`fromLocationId`	integer (int64)
`modeId`	string
`module`	Module1	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`toAddress`	TransportEndpointDto	An address endpoint of a transport leg, used where no logistics location applies
`toLocationId`	integer (int64)

TransportModeDto

Felt	Type	Beskrivelse
`activityMode`	string
`catalogVersion`	string
`description`	string
`factor`	FactorDto
`id`	string
`name`	string

TransportNoteDto

A note about a direction that produced no leg

Felt	Type	Beskrivelse
`code`	Code	Why this note was added Én av: `CUSTOMER_HANDLES_TRANSPORT`, `NO_PICKUP`, `NO_DELIVERY`
`direction`	Direction	Whether the leg is arrival transport (a process input) or departure transport (a process output) Én av: `ARRIVAL`, `DEPARTURE`
`lineNumbers`	liste av integer (int32)
`message`	string

TransportOverrideDto

A restated transport leg; anything not stated keeps its modelled value

Felt	Type	Beskrivelse
`cargoMassKg`	number (double)
`distanceKm`	number (double)
`from`	EndpointOverrideDto	One end of a restated leg: a location category id, or an address with optional coordinates — never both
`modeId`	string
`to`	EndpointOverrideDto	One end of a restated leg: a location category id, or an address with optional coordinates — never both

TransportReportDto

Transport emissions for one shipment over one chain of legs

Felt	Type	Beskrivelse
`catalogVersion`	string
`correlationId`	string
`description`	string
`disclosure`	DisclosureDto	What the report does not count, and what its figures rest on
`freight`	FreightResultDto	The shipment, and how its mass was established
`id`	string
`intensityGCo2ePerTkm`	number (double)
`legs`	liste av LegResultDto
`name`	string
`timestamp`	Instant
`total`	Co2eSplitDto	CO2e in kg, split well-to-wheel = tank-to-wheel + well-to-tank
`totalDistanceKm`	number (double)
`totalTonneKm`	number (double)

TransportReportRequestDto

A shipment and the chain of transport legs it moves over

Felt	Type	Beskrivelse
`correlationId`	string
`description`	string
`freight` *	FreightDto	The goods moved over the chain
`legs` *	liste av LegDto
`name`	string

Type

Én av: PRODUCTION, SERVICE

Type1

Én av: NATURAL_RESOURCE, VIRGIN_RESOURCE, RECOVERABLE_RESOURCE, NON_RECOVERABLE_RESOURCE, RECOVERED_RESOURCE, ENERGY, WASTE, LOSS

Type10

Én av: CFP

Type2

Én av: RECOVER_VALUE, RETAIN_VALUE, ADD_VALUE, PRODUCTION

Type3

Én av: ASSET, RESOURCE, RELEASE, FUNCTIONAL_UNIT

Type4

Én av: BUILDING, MACHINE

Type5

Én av: RESOURCE, ASSET_TIME, LOCATION_TIME, LOCATION_ALLOCATION, FUNCTIONAL_UNIT, EMISSION, WASTE, LOSS, TRANSPORT

Type6

Én av: RECOVER_VALUE, RETAIN_VALUE, ADD_VALUE, PRODUCTION

Type7

Én av: CH4_NON_FOSSIL, N2O, SF6, NF3, CH4_FOSSIL, CO2E, CO2

Type8

Én av: ROUTED_PATH, STRAIGHT_LINE

Type9

Én av: MASS_LIMITED, VOLUME_LIMITED

UUID

string (uuid)

Unit

Én av: KG, L, M2, M3, KWH, COUNT, MINUTES, TKM

Unit1

Én av: KG, L, M2, M3, KWH, COUNT, MINUTES, TKM

UnitProcess

Felt	Type	Beskrivelse
`description`	string
`function`	Function
`id`	string
`inputs`	liste av FlowConfig
`module`	Module	Én av: `A1`, `A2`, `A3`, `A4`, `A5`, `CRADLE_TO_GATE`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `C1`, `C2`, `C3`, `C4`, `D`, `CRADLE_TO_GRAVE`
`outputs`	liste av FlowConfig
`type`	Type2	Én av: `RECOVER_VALUE`, `RETAIN_VALUE`, `ADD_VALUE`, `PRODUCTION`

UnitProcessDto

Felt	Type	Beskrivelse
`classification`	ProcessClassification	Én av: `FOREGROUND`, `BACKGROUND`
`description`	string
`geography`	string	Where a BACKGROUND process sits, as free text — a country, a region, a trade mix or a route. Mutually exclusive with locationId, which names a location the provider operates and is how a FOREGROUND process locates itself.
`inputs`	liste av FlowDto
`locationId`	integer (int64)
`name`	string
`outputs`	liste av FlowDto

UpdateApiKeyDto

Felt	Type	Beskrivelse
`active`	boolean
`description`	string
`expiresAt`	Instant
`name` *	string
`permissions` *	liste av Permission

UpdateCategoryDto

Felt	Type	Beskrivelse
`categoryProperties`	liste av CategoryPropertyDto
`description`	string
`name`	string
`parentCategoryId`	integer (int64)

UpdateEntitlementDto

Felt	Type	Beskrivelse
`active`	boolean
`plan` *	string

UpdateOrganizationBillingDto

Felt	Type	Beskrivelse
`addOns`	liste av FunctionalAddOn
`billingAddress`	AddressDto2
`subscriptionLevel`	SubscriptionLevelPatch	The plan the organization is on. Omit to leave the subscription unchanged; send null to cancel it; send a plan to set it.

UpdateOrganizationDto

Felt	Type	Beskrivelse
`address`	AddressDto2
`config`	OrganizationConfigDto
`description`	string
`name` *	string
`organizationNumber`	string
`vatRegistered`	boolean

UpdateUserDto

Felt	Type	Beskrivelse
`name` *	string
`permissions`	liste av Permission

UserDto

Felt	Type	Beskrivelse
`email`	string
`id`	integer (int64)
`name`	string
`organizations`	liste av UserOrganizationDto
`permissions`	liste av Permission
`status`	UserOrganizationStatus	Én av: `INVITED`, `ACTIVE`
`sub`	string

UserOrganizationDto

Felt	Type	Beskrivelse
`organizationId`	string
`organizationName`	string
`permissions`	liste av Permission
`status`	UserOrganizationStatus	Én av: `INVITED`, `ACTIVE`

UserOrganizationStatus

Én av: INVITED, ACTIVE

UserPermissionsResponseDto

Felt	Type	Beskrivelse
`organizationNames`	map av string
`organizations`	liste av string
`permissions`	liste av string

ValueDto

Felt	Type	Beskrivelse
`unit`	string
`value`	number (double)

Variability

Én av: FIXED, OPTIONAL, SUBSTITUTABLE

Referanse: Asset API

Referanse: Orgadmin API

Access Grant Resource link

/{org}/access-grant link

/{org}/access-grant/incoming link

/{org}/access-grant/{recipientOrg} link

Api Key Permissions Resource link

/api-key/last-used link

/api-key/permissions link

Api Key Resource link

/{org}/api-key link

/{org}/api-key/{id} link

/{org}/api-key/{id}/regenerate-secret link

Category Resource link

/{org}/category link

/{org}/category/{parentcategory} link

/{org}/category/{parentcategory}/{categoryid} link

/{org}/category/{parentcategory}/{parentcategoryid} link

Emission Factor Resource link

/emission-factors/spend link

/emission-factors/spend/{id} link

Entitlement Resource link

/{org}/entitlement link

/{org}/entitlement/{appId} link

Instance reports link

/{org}/report/solution/{id}/instance link

/{org}/report/solution/{id}/parameters link

Invitation Resource link

/invitation/{invitationId} link

/invitation/{invitationId}/accept link

Order reports link

/{org}/report/order link

Organization Admin Resource link

/ link

/{org} link

/{org}/billing link

/{org}/invite link

/{org}/signup link

/{org}/stats link

Organization logo link

/{org}/logo link

Products link

/{org}/product link

/{org}/product/{id} link

Providers Resource link

/providers link

Public Categories Resource link

/categories link

Public Reports link

/{org}/report/solution/{id} link

Report Qualifications Resource link

/report/qualifications link

Services link

/{org}/service link

/{org}/service/public link

/{org}/service/{id} link

Site admin link

/site/organizations link

/site/organizations/{id} link

/site/organizations/{id}/users link

/site/users link

Solution images link

/{org}/solution/{id}/image link

/{org}/solution/{id}/image/order link

/{org}/solution/{id}/image/{imageId} link

Solutions Resource link

/solutions link

/solutions/{id} link

Taxonomy Resource link

/taxonomies link

Transport Mode Resource link

/transport/modes link

Transport reports link

/{org}/transport/report link

User Permissions Resource link

/user/permissions link

User Resource link

/{org}/user link

/{org}/user/{userid} link

Skjemaer link

AccessGrantDto

Access Grant Resource

`/{org}/access-grant`

`/{org}/access-grant/incoming`

`/{org}/access-grant/{recipientOrg}`

Api Key Permissions Resource

`/api-key/last-used`

`/api-key/permissions`

Api Key Resource

`/{org}/api-key`

`/{org}/api-key/{id}`

`/{org}/api-key/{id}/regenerate-secret`

Category Resource

`/{org}/category`

`/{org}/category/{parentcategory}`

`/{org}/category/{parentcategory}/{categoryid}`

`/{org}/category/{parentcategory}/{parentcategoryid}`

Emission Factor Resource

`/emission-factors/spend`

`/emission-factors/spend/{id}`

Entitlement Resource

`/{org}/entitlement`

`/{org}/entitlement/{appId}`

Instance reports

`/{org}/report/solution/{id}/instance`

`/{org}/report/solution/{id}/parameters`

Invitation Resource

`/invitation/{invitationId}`

`/invitation/{invitationId}/accept`

Order reports

`/{org}/report/order`

Organization Admin Resource

`/`

`/{org}`

`/{org}/billing`

`/{org}/invite`

`/{org}/signup`

`/{org}/stats`

Organization logo

`/{org}/logo`

Products

`/{org}/product`

`/{org}/product/{id}`

Providers Resource

`/providers`

Public Categories Resource

`/categories`

Public Reports

`/{org}/report/solution/{id}`

Report Qualifications Resource

`/report/qualifications`

Services

`/{org}/service`

`/{org}/service/public`

`/{org}/service/{id}`

Site admin

`/site/organizations`

`/site/organizations/{id}`

`/site/organizations/{id}/users`

`/site/users`

Solution images

`/{org}/solution/{id}/image`

`/{org}/solution/{id}/image/order`

`/{org}/solution/{id}/image/{imageId}`

Solutions Resource

`/solutions`

`/solutions/{id}`

Taxonomy Resource

`/taxonomies`

Transport Mode Resource

`/transport/modes`

Transport reports

`/{org}/transport/report`

User Permissions Resource

`/user/permissions`

User Resource

`/{org}/user`

`/{org}/user/{userid}`

Skjemaer