Zero Labs GraphQL Documentation
Welcome to our GraphQL API reference, your comprehensive guide to interacting with our powerful GraphQL API. Whether you're a developer building applications, a partner integrating our services, or simply curious about how our API works, this reference is your go-to resource.
API Endpoints
# GraphQL backend URL:
https://api.proofs.green/graphql
Headers
Authorization: Bearer <ACCESS_TOKEN>
# OR
X-API-KEY: example123Queries
calculateAverageConsumptionInPeriod
Description
Calculates the average consumption for a given period. Returns 0 if period length or energy amount is 0.
Response
Returns a String
Arguments
| Name | Description |
|---|---|
body - AverageCalculationRq
|
Example
Query
query CalculateAverageConsumptionInPeriod($body: AverageCalculationRq) {
calculateAverageConsumptionInPeriod(body: $body)
}
Variables
{"body": AverageCalculationRq}
Response
{
"data": {
"calculateAverageConsumptionInPeriod": "xyz789"
}
}
calculateConsumerEstimatedClean
Description
Calculate estimated clean energy amounts for a consumer within a date range.
Response
Returns [ConsumerEstimatedCleanDTO!]
Arguments
| Name | Description |
|---|---|
body - CalculateConsumerEstimatedCleanRq!
|
Example
Query
query CalculateConsumerEstimatedClean($body: CalculateConsumerEstimatedCleanRq!) {
calculateConsumerEstimatedClean(body: $body) {
endDate
energyAmountInWh
startDate
}
}
Variables
{"body": CalculateConsumerEstimatedCleanRq}
Response
{
"data": {
"calculateConsumerEstimatedClean": [
{
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"startDate": "2022-01-01"
}
]
}
}
calculateScope3AllocationAmounts
Description
Calculate Scope 3 allocation amounts based on the provided request.
Response
Returns a Scope3AllocationAmountsDTO!
Arguments
| Name | Description |
|---|---|
body - CalculateScope3AllocationAmountsRq!
|
Example
Query
query CalculateScope3AllocationAmounts($body: CalculateScope3AllocationAmountsRq!) {
calculateScope3AllocationAmounts(body: $body) {
allocatedCleanEnergyAmountInWh
allocatedConsumedEnergyAmountInWh
totalCleanEnergyAmountInWh
totalConsumedEnergyAmountInWh
}
}
Variables
{"body": CalculateScope3AllocationAmountsRq}
Response
{
"data": {
"calculateScope3AllocationAmounts": {
"allocatedCleanEnergyAmountInWh": "1000",
"allocatedConsumedEnergyAmountInWh": "1000",
"totalCleanEnergyAmountInWh": "1000",
"totalConsumedEnergyAmountInWh": "1000"
}
}
}
calculateSubscriptionPrice
Description
Calculate subscription price based on offer, duration and consumers.
Response
Returns a SubscriptionPriceDTO
Arguments
| Name | Description |
|---|---|
body - CalculateSubscriptionPriceRq
|
Example
Query
query CalculateSubscriptionPrice($body: CalculateSubscriptionPriceRq) {
calculateSubscriptionPrice(body: $body) {
currency
price
}
}
Variables
{"body": CalculateSubscriptionPriceRq}
Response
{
"data": {
"calculateSubscriptionPrice": {
"currency": "abc123",
"price": 987.65
}
}
}
getAITaskList
Description
Get a paginated list of AI tasks with optional filtering.
Response
Returns an AITaskListRs
Arguments
| Name | Description |
|---|---|
body - AITaskListRq
|
Example
Query
query GetAITaskList($body: AITaskListRq) {
getAITaskList(body: $body) {
data {
correctedResult
error
file {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
id
result
status
tags
}
pagination {
skip
take
total
}
}
}
Variables
{"body": AITaskListRq}
Response
{
"data": {
"getAITaskList": {
"data": [AITaskDTO],
"pagination": PaginationRs
}
}
}
getCertificateById
Description
Get detailed certificate information by ID.
Response
Returns a CertificateDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetCertificateById($id: ID!) {
getCertificateById(id: $id) {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getCertificateById": {
"claimSingleEventResponses": [
ClaimSingleEventResponse
],
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"isGreenECertified": false,
"label": "SOME_LABEL",
"openVolumeInWh": "1000",
"productType": "EUGO",
"providerReferenceNumber": "xyz789",
"recSource": RecSourceDTO,
"recSourceDistributions": [
CertificateRecSourceDistributionDTO
],
"redemption": RedemptionDTO,
"status": "CREATED",
"supplier": OrganizationDTO,
"tenant": OrganizationDTO,
"w3Id": "abc123",
"w3MintBlock": 42
}
}
}
getCertificateList
Description
Get a paginated list of certificates with optional filtering.
Response
Returns a CertificateListRs
Arguments
| Name | Description |
|---|---|
body - CertificateListRq
|
Example
Query
query GetCertificateList($body: CertificateListRq) {
getCertificateList(body: $body) {
data {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
...CertificateDTOFragment
}
comment
description
energyAmountInWh
fullText
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
mintCertificatesTxHash
name
protocolVersion
recSource {
...RecSourceDTOFragment
}
redemptionStatement {
...FileDTOFragment
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
...OrganizationDTOFragment
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
pagination {
skip
take
total
}
}
}
Variables
{"body": CertificateListRq}
Response
{
"data": {
"getCertificateList": {
"data": [CertificateDTO],
"pagination": PaginationRs
}
}
}
getConsumerById
Description
Get detailed consumer information by ID.
Response
Returns a ConsumerDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetConsumerById($id: ID!) {
getConsumerById(id: $id) {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
consumerFieldType
description
name
orderNumber
required
}
description
entityType
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getConsumerById": {
"address": "Some Address 123",
"data": [ConsumerFieldDTO],
"deliveryPartners": [OrganizationDTO],
"description": "This is a description",
"documents": [FileDTO],
"emissionsFactor": ConsumerEmissionsFactorDTO,
"estimatedDailyConsumptionInWh": "xyz789",
"estimatedMonthlyConsumptions": [
EstimatedMonthlyConsumptionDTO
],
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"latitude": "abc123",
"location": LocationDTO,
"longitude": "xyz789",
"measuringPartners": [OrganizationDTO],
"metadata": ConsumerMetadataDTO,
"name": "Some Name",
"organization": OrganizationDTO,
"percentGreenGoal": 42,
"priorityListIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"productType": "EUGO",
"tags": ["abc123"],
"tenant": OrganizationDTO
}
}
}
getConsumerList
Description
Get a paginated list of consumers with optional filtering and sorting.
Response
Returns a ConsumerListRs
Arguments
| Name | Description |
|---|---|
body - ConsumerListRq
|
Example
Query
query GetConsumerList($body: ConsumerListRq) {
getConsumerList(body: $body) {
data {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ConsumerListRq}
Response
{
"data": {
"getConsumerList": {
"data": [ConsumerDTO],
"pagination": PaginationRs
}
}
}
getConsumerListConsumptionData
Description
Get monthly consumption data for consumers, including total and decarbonized amounts. Results are sorted by year and month.
Response
Returns a ConsumerListConsumptionDataRs
Arguments
| Name | Description |
|---|---|
filters - ConsumerFiltersRq
|
Example
Query
query GetConsumerListConsumptionData($filters: ConsumerFiltersRq) {
getConsumerListConsumptionData(filters: $filters) {
data {
consumptionAmountInWh
decarbonizedAmountInWh
month
year
}
}
}
Variables
{"filters": ConsumerFiltersRq}
Response
{
"data": {
"getConsumerListConsumptionData": {
"data": [ConsumerMonthlyConsumptionDataDTO]
}
}
}
getConsumerMetadataList
Description
Get a paginated list of consumer metadata templates with optional filtering.
Response
Returns a ConsumerMetadataListRs
Arguments
| Name | Description |
|---|---|
body - ConsumerMetadataListRq
|
Example
Query
query GetConsumerMetadataList($body: ConsumerMetadataListRq) {
getConsumerMetadataList(body: $body) {
data {
data {
consumerFieldType
description
name
orderNumber
required
}
description
entityType
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
name
tenantId
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ConsumerMetadataListRq}
Response
{
"data": {
"getConsumerMetadataList": {
"data": [ConsumerMetadataDTO],
"pagination": PaginationRs
}
}
}
getConsumerSummary
Description
Get consumer count summary.
Response
Returns a ConsumerSummaryDTO
Arguments
| Name | Description |
|---|---|
body - ConsumerFiltersRq
|
Example
Query
query GetConsumerSummary($body: ConsumerFiltersRq) {
getConsumerSummary(body: $body) {
numberOfConsumers
}
}
Variables
{"body": ConsumerFiltersRq}
Response
{"data": {"getConsumerSummary": {"numberOfConsumers": 42}}}
getConsumptionList
Description
Get a paginated list of consumptions with optional filtering and sorting.
Response
Returns a ConsumptionListRs
Arguments
| Name | Description |
|---|---|
body - ConsumptionListRq
|
Example
Query
query GetConsumptionList($body: ConsumptionListRq) {
getConsumptionList(body: $body) {
data {
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ConsumptionListRq}
Response
{
"data": {
"getConsumptionList": {
"data": [ConsumptionDTO],
"pagination": PaginationRs
}
}
}
getConsumptionScope3AllocationList
Description
Get a paginated list of Scope 3 allocated consumptions.
Response
Returns a ConsumptionScope3AllocationListRs
Arguments
| Name | Description |
|---|---|
body - ConsumptionScope3AllocationListRq
|
Example
Query
query GetConsumptionScope3AllocationList($body: ConsumptionScope3AllocationListRq) {
getConsumptionScope3AllocationList(body: $body) {
data {
cleanEnergyAmountInWh
consumedEnergyAmountInWh
consumption {
certificates {
...CertificateClaimDTOFragment
}
consumer {
...ConsumerDTOFragment
}
decarbonizationStatus
deliveryPartners {
...OrganizationDTOFragment
}
deploymentStatus
documents {
...FileDTOFragment
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
...OrganizationDTOFragment
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
endDate
id
scope3Allocation {
cleanEnergyAmountInWh
consumedEnergyAmountInWh
consumer {
...ConsumerDTOFragment
}
endDate
id
organization {
...OrganizationDTOFragment
}
startDate
}
startDate
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ConsumptionScope3AllocationListRq}
Response
{
"data": {
"getConsumptionScope3AllocationList": {
"data": [ConsumptionScope3AllocationDTO],
"pagination": PaginationRs
}
}
}
getConsumptionScope3AllocationSummary
Description
Get consumption-specific Scope 3 allocation summary.
Response
Returns a ConsumptionScope3AllocationSummaryDTO
Arguments
| Name | Description |
|---|---|
body - ConsumptionScope3AllocationFiltersRq
|
Example
Query
query GetConsumptionScope3AllocationSummary($body: ConsumptionScope3AllocationFiltersRq) {
getConsumptionScope3AllocationSummary(body: $body) {
numberOfAllocations
totalCleanAmountInWh
totalConsumedAmountInWh
}
}
Variables
{"body": ConsumptionScope3AllocationFiltersRq}
Response
{
"data": {
"getConsumptionScope3AllocationSummary": {
"numberOfAllocations": 42,
"totalCleanAmountInWh": "1000",
"totalConsumedAmountInWh": "1000"
}
}
}
getConsumptionSummary
Description
Get consumption summary.
Response
Returns a ConsumptionSummaryDTO
Arguments
| Name | Description |
|---|---|
body - ConsumptionFiltersRq
|
Example
Query
query GetConsumptionSummary($body: ConsumptionFiltersRq) {
getConsumptionSummary(body: $body) {
averageAmountInWh
numberOfConsumptions
perYearSummary {
totalAmountInWh
year
}
totalAmountInWh
}
}
Variables
{"body": ConsumptionFiltersRq}
Response
{
"data": {
"getConsumptionSummary": {
"averageAmountInWh": "1000",
"numberOfConsumptions": 42,
"perYearSummary": [AmountPerYearSummary],
"totalAmountInWh": "1000"
}
}
}
getFileList
Description
Get a paginated list of files with optional filtering.
Response
Returns a FileListRs
Arguments
| Name | Description |
|---|---|
body - FileListRq
|
Example
Query
query GetFileList($body: FileListRq) {
getFileList(body: $body) {
data {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
pagination {
skip
take
total
}
}
}
Variables
{"body": FileListRq}
Response
{
"data": {
"getFileList": {
"data": [FileDTO],
"pagination": PaginationRs
}
}
}
getGeneratorList
Description
Get a paginated list of generators with optional filtering.
Response
Returns a GeneratorListRs
Arguments
| Name | Description |
|---|---|
body - GeneratorListRq
|
Example
Query
query GetGeneratorList($body: GeneratorListRq) {
getGeneratorList(body: $body) {
data {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
pagination {
skip
take
total
}
}
}
Variables
{"body": GeneratorListRq}
Response
{
"data": {
"getGeneratorList": {
"data": [GeneratorDTO],
"pagination": PaginationRs
}
}
}
getMatchingOffer
Description
Get matching offer for product type and amount.
Response
Returns an OfferDTO
Arguments
| Name | Description |
|---|---|
body - MatchingOfferRequestRq
|
Example
Query
query GetMatchingOffer($body: MatchingOfferRequestRq) {
getMatchingOffer(body: $body) {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
pricePerWh
productType
tags
}
}
Variables
{"body": MatchingOfferRequestRq}
Response
{
"data": {
"getMatchingOffer": {
"availableCertificateEnergyAmountInWh": "1000",
"availableOrderEnergyAmountInWh": "1000",
"currency": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"image": FileDTO,
"pricePerWh": 123.45,
"productType": "EUGO",
"tags": ["abc123"]
}
}
}
getOfferList
Description
Get a paginated list of offers with optional filtering.
Response
Returns an OfferListRs
Arguments
| Name | Description |
|---|---|
body - OfferListRq
|
Example
Query
query GetOfferList($body: OfferListRq) {
getOfferList(body: $body) {
data {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
pricePerWh
productType
tags
}
pagination {
skip
take
total
}
}
}
Variables
{"body": OfferListRq}
Response
{
"data": {
"getOfferList": {
"data": [OfferDTO],
"pagination": PaginationRs
}
}
}
getOrganizationById
Description
Get detailed organization information by ID.
Response
Returns an OrganizationDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetOrganizationById($id: ID!) {
getOrganizationById(id: $id) {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
numberOfConsumers
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
averageAmountInWh
energySourcesSummary {
...ProofEnergyTypeSummaryFragment
}
numberOfProofs
perYearSummary {
...AmountPerYearSummaryFragment
}
totalAmountInWh
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getOrganizationById": {
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "xyz789",
"colorSecondary": "xyz789",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"inventoryIds": ["1_1"],
"isOrganizationAdminRegistered": true,
"isRecProvider": false,
"location": LocationDTO,
"logo": FileDTO,
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"onboardingPartnerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"partnershipText": "abc123",
"publicEmail": "some-email@example.org",
"settings": TenantSettingsDTO,
"shortText": "xyz789",
"social": "@SomeHandle",
"summary": OrganizationSummariesDTO,
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["xyz789"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"vat": "abc123",
"website": "https://example.org",
"zip": "92704"
}
}
}
getOrganizationList
Description
Get a paginated list of organizations with optional filtering.
Response
Returns an OrganizationListRs
Arguments
| Name | Description |
|---|---|
body - OrganizationListRq
|
Example
Query
query GetOrganizationList($body: OrganizationListRq) {
getOrganizationList(body: $body) {
data {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
pagination {
skip
take
total
}
}
}
Variables
{"body": OrganizationListRq}
Response
{
"data": {
"getOrganizationList": {
"data": [OrganizationDTO],
"pagination": PaginationRs
}
}
}
getOrganizationSummary
Description
Get organization count summary.
Response
Returns an OrganizationSummaryDTO
Arguments
| Name | Description |
|---|---|
body - OrganizationFiltersRq
|
Example
Query
query GetOrganizationSummary($body: OrganizationFiltersRq) {
getOrganizationSummary(body: $body) {
numberOfOrganizations
}
}
Variables
{"body": OrganizationFiltersRq}
Response
{"data": {"getOrganizationSummary": {"numberOfOrganizations": 42}}}
getPriorityListById
Description
Get priority list by ID.
Response
Returns a PriorityListDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetPriorityListById($id: ID!) {
getPriorityListById(id: $id) {
description
id
items {
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
name
recSources {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
tags
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getPriorityListById": {
"description": "This is a description",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"items": [PriorityListItemDTO],
"name": "Some Name",
"recSources": [RecSourceDTO],
"tags": ["abc123"]
}
}
}
getPriorityListItemById
Description
Get priority list item by ID.
Response
Returns a PriorityListItemDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetPriorityListItemById($id: ID!) {
getPriorityListItemById(id: $id) {
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getPriorityListItemById": {
"consumer": ConsumerDTO,
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"percentage": 42,
"priority": 42,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tags": ["abc123"]
}
}
}
getPriorityListItems
Description
Get priority list items with optional filtering and sorting.
Response
Returns a PriorityListItemsRs
Arguments
| Name | Description |
|---|---|
body - PriorityListItemRq
|
Example
Query
query GetPriorityListItems($body: PriorityListItemRq) {
getPriorityListItems(body: $body) {
data {
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
pagination {
skip
take
total
}
}
}
Variables
{"body": PriorityListItemRq}
Response
{
"data": {
"getPriorityListItems": {
"data": [PriorityListItemDTO],
"pagination": PaginationRs
}
}
}
getPriorityLists
Description
Get priority lists with optional filtering.
Response
Returns a PriorityListsRs
Arguments
| Name | Description |
|---|---|
body - PriorityListRq
|
Example
Query
query GetPriorityLists($body: PriorityListRq) {
getPriorityLists(body: $body) {
data {
description
id
items {
consumer {
...ConsumerDTOFragment
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
name
recSources {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
tags
}
pagination {
skip
take
total
}
}
}
Variables
{"body": PriorityListRq}
Response
{
"data": {
"getPriorityLists": {
"data": [PriorityListDTO],
"pagination": PaginationRs
}
}
}
getProofById
Description
Get detailed proof information by ID.
Example
Query
query GetProofById($id: ID!) {
getProofById(id: $id) {
attestationUrl
certificates {
amountInWh
certificate {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
}
consumption {
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
creationDate
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
energyAmountInWh
energyTypes
generators {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
productTypes
suppliers {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getProofById": {
"attestationUrl": "abc123",
"certificates": [CertificateClaimDTO],
"consumption": ConsumptionDTO,
"creationDate": "2022-09-21",
"deliveryPartners": [OrganizationDTO],
"energyAmountInWh": "1000",
"energyTypes": ["BIOGAS"],
"generators": [GeneratorDTO],
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"measuringPartners": [OrganizationDTO],
"metadata": "abc123",
"productTypes": ["EUGO"],
"suppliers": [OrganizationDTO],
"tenant": OrganizationDTO
}
}
}
getProofList
Description
Get a paginated list of proofs with optional filtering and sorting.
Response
Returns a ProofListRs
Arguments
| Name | Description |
|---|---|
body - ProofListRq
|
Example
Query
query GetProofList($body: ProofListRq) {
getProofList(body: $body) {
data {
attestationUrl
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumption {
certificates {
...CertificateClaimDTOFragment
}
consumer {
...ConsumerDTOFragment
}
decarbonizationStatus
deliveryPartners {
...OrganizationDTOFragment
}
deploymentStatus
documents {
...FileDTOFragment
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
...OrganizationDTOFragment
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
creationDate
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
energyAmountInWh
energyTypes
generators {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
productTypes
suppliers {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ProofListRq}
Response
{
"data": {
"getProofList": {
"data": [ProofDTO],
"pagination": PaginationRs
}
}
}
getProofProposalList
Description
Get a paginated list of proof proposals with optional filtering.
Response
Returns a ProofProposalListRs
Arguments
| Name | Description |
|---|---|
body - ProofProposalListRq
|
Example
Query
query GetProofProposalList($body: ProofProposalListRq) {
getProofProposalList(body: $body) {
data {
certificateAmounts {
certificate {
...CertificateDTOFragment
}
energyAmountInWh
}
consumption {
certificates {
...CertificateClaimDTOFragment
}
consumer {
...ConsumerDTOFragment
}
decarbonizationStatus
deliveryPartners {
...OrganizationDTOFragment
}
deploymentStatus
documents {
...FileDTOFragment
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
...OrganizationDTOFragment
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
id
priorityListItem {
consumer {
...ConsumerDTOFragment
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
proof {
attestationUrl
certificates {
...CertificateClaimDTOFragment
}
consumption {
...ConsumptionDTOFragment
}
creationDate
deliveryPartners {
...OrganizationDTOFragment
}
energyAmountInWh
energyTypes
generators {
...GeneratorDTOFragment
}
id
measuringPartners {
...OrganizationDTOFragment
}
metadata
productTypes
suppliers {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
}
status
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ProofProposalListRq}
Response
{
"data": {
"getProofProposalList": {
"data": [ProofProposalDTO],
"pagination": PaginationRs
}
}
}
getProofProposalSummary
Description
Get proof proposal summary.
Response
Returns a ProofProposalSummaryDTO
Arguments
| Name | Description |
|---|---|
body - ProofProposalFiltersRq
|
Example
Query
query GetProofProposalSummary($body: ProofProposalFiltersRq) {
getProofProposalSummary(body: $body) {
numberOfProposals
totalAmountInWh
}
}
Variables
{"body": ProofProposalFiltersRq}
Response
{
"data": {
"getProofProposalSummary": {
"numberOfProposals": 42,
"totalAmountInWh": "1000"
}
}
}
getProofRequestList
Description
Get a paginated list of proof requests with optional filtering and sorting.
Response
Returns a ProofRequestListRs
Arguments
| Name | Description |
|---|---|
body - ProofRequestListRq
|
Example
Query
query GetProofRequestList($body: ProofRequestListRq) {
getProofRequestList(body: $body) {
data {
checkoutSessionUrl
consumptions {
certificates {
...CertificateClaimDTOFragment
}
consumer {
...ConsumerDTOFragment
}
decarbonizationStatus
deliveryPartners {
...OrganizationDTOFragment
}
deploymentStatus
documents {
...FileDTOFragment
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
...OrganizationDTOFragment
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
id
offer {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
...FileDTOFragment
}
pricePerWh
productType
tags
}
paymentStatus
preferences {
consumptionLocationStrict
consumptionTimeStrict
energyTypes
}
status
tags
}
pagination {
skip
take
total
}
}
}
Variables
{"body": ProofRequestListRq}
Response
{
"data": {
"getProofRequestList": {
"data": [ProofRequestDTO],
"pagination": PaginationRs
}
}
}
getProofSummary
Description
Get proof summary.
Response
Returns a ProofSummaryDTO
Arguments
| Name | Description |
|---|---|
body - ProofFiltersRq
|
Example
Query
query GetProofSummary($body: ProofFiltersRq) {
getProofSummary(body: $body) {
averageAmountInWh
energySourcesSummary {
energySources
numberOfProofs
totalAmountInWh
}
numberOfProofs
perYearSummary {
totalAmountInWh
year
}
totalAmountInWh
}
}
Variables
{"body": ProofFiltersRq}
Response
{
"data": {
"getProofSummary": {
"averageAmountInWh": "1000",
"energySourcesSummary": [ProofEnergyTypeSummary],
"numberOfProofs": 42,
"perYearSummary": [AmountPerYearSummary],
"totalAmountInWh": "1000"
}
}
}
getRecSourceById
Description
Get detailed REC source information by ID.
Response
Returns a RecSourceDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetRecSourceById($id: ID!) {
getRecSourceById(id: $id) {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getRecSourceById": {
"currency": "abc123",
"deliveryDate": "2022-09-21",
"deliveryType": "ONE_TIME",
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"energyAmountPercentage": "1000",
"energySources": ["BIOGAS"],
"externalId": "SOME_EXTERNAL_ID-1234",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventory": W3BlockchainPropertiesDTO,
"label": "SOME_LABEL",
"locations": [LocationDTO],
"orderDate": "2022-09-21",
"pricePerWh": 987.65,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"productType": "EUGO",
"provider": OrganizationDTO,
"recurringDeliveryPeriod": "DAILY",
"recurringType": "GreenTariff",
"startDate": "2022-01-01",
"tenant": OrganizationDTO
}
}
}
getRecSourceList
Description
Get a paginated list of REC sources with optional filtering.
Response
Returns a RecSourceListRs
Arguments
| Name | Description |
|---|---|
body - RecSourceListRq
|
Example
Query
query GetRecSourceList($body: RecSourceListRq) {
getRecSourceList(body: $body) {
data {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
pagination {
skip
take
total
}
}
}
Variables
{"body": RecSourceListRq}
Response
{
"data": {
"getRecSourceList": {
"data": [RecSourceDTO],
"pagination": PaginationRs
}
}
}
getRecSourceSummary
Description
Get REC source summary.
Response
Returns a RecSourceSummaryDTO
Arguments
| Name | Description |
|---|---|
body - RecSourceListRq
|
Example
Query
query GetRecSourceSummary($body: RecSourceListRq) {
getRecSourceSummary(body: $body) {
averageAmountInWh
currencySummary {
averageCost
averagePrice
currency
totalCost
totalPrice
}
numberOfRecSources
totalAmountInWh
totalNameplateCapacityInW
}
}
Variables
{"body": RecSourceListRq}
Response
{
"data": {
"getRecSourceSummary": {
"averageAmountInWh": "1000",
"currencySummary": [RecSourceCurrencySummary],
"numberOfRecSources": 42,
"totalAmountInWh": "1000",
"totalNameplateCapacityInW": "Some Name"
}
}
}
getRedemptionById
Description
Get detailed redemption information by ID.
Response
Returns a RedemptionDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetRedemptionById($id: ID!) {
getRedemptionById(id: $id) {
certificates {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
...CertificateDTOFragment
}
comment
description
energyAmountInWh
fullText
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
mintCertificatesTxHash
name
protocolVersion
recSource {
...RecSourceDTOFragment
}
redemptionStatement {
...FileDTOFragment
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
...OrganizationDTOFragment
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getRedemptionById": {
"certificates": [CertificateDTO],
"comment": "Some random comment",
"description": "This is a description",
"energyAmountInWh": "1000",
"fullText": "abc123",
"id": "0x0d63730e6522d34fb200e2399a262ef96cbf46ee8da762383111d1bcd200c752",
"inventory": W3BlockchainPropertiesDTO,
"mintCertificatesTxHash": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"name": "Some Name",
"protocolVersion": "xyz789",
"recSource": RecSourceDTO,
"redemptionStatement": FileDTO,
"redemptionStatementBcStatus": "REDEMPTION_STATEMENT_NOT_SET",
"redemptionStatementTxBlock": 42,
"redemptionStatementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"registry": "abc123",
"shortText": "xyz789",
"status": "APPROVED",
"storagePointer": "xyz789",
"tags": ["xyz789"],
"tenant": OrganizationDTO,
"title": "This is a Title",
"trustLink": "ONE_DIRECTIONAL"
}
}
}
getRedemptionList
Description
Get a paginated list of redemptions with optional filtering.
Response
Returns a RedemptionListRs
Arguments
| Name | Description |
|---|---|
body - RedemptionListRq
|
Example
Query
query GetRedemptionList($body: RedemptionListRq) {
getRedemptionList(body: $body) {
data {
certificates {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
pagination {
skip
take
total
}
}
}
Variables
{"body": RedemptionListRq}
Response
{
"data": {
"getRedemptionList": {
"data": [RedemptionDTO],
"pagination": PaginationRs
}
}
}
getScope3AllocationList
Description
Get a paginated list of Scope 3 allocations with optional filtering and sorting.
Response
Returns a Scope3AllocationListRs
Arguments
| Name | Description |
|---|---|
body - Scope3AllocationListRq
|
Example
Query
query GetScope3AllocationList($body: Scope3AllocationListRq) {
getScope3AllocationList(body: $body) {
data {
cleanEnergyAmountInWh
consumedEnergyAmountInWh
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
endDate
id
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
startDate
}
pagination {
skip
take
total
}
}
}
Variables
{"body": Scope3AllocationListRq}
Response
{
"data": {
"getScope3AllocationList": {
"data": [Scope3AllocationDTO],
"pagination": PaginationRs
}
}
}
getScope3AllocationSummary
Description
Get Scope 3 allocation summary.
Response
Returns a Scope3AllocationSummaryDTO
Arguments
| Name | Description |
|---|---|
body - Scope3AllocationFiltersRq
|
Example
Query
query GetScope3AllocationSummary($body: Scope3AllocationFiltersRq) {
getScope3AllocationSummary(body: $body) {
numberOfAllocations
totalCleanAmountInWh
totalConsumedAmountInWh
}
}
Variables
{"body": Scope3AllocationFiltersRq}
Response
{
"data": {
"getScope3AllocationSummary": {
"numberOfAllocations": 42,
"totalCleanAmountInWh": "1000",
"totalConsumedAmountInWh": "1000"
}
}
}
getSubscriptionList
Description
Get a paginated list of subscriptions with optional filtering and sorting.
Response
Returns a SubscriptionListRs
Arguments
| Name | Description |
|---|---|
body - SubscriptionListRq
|
Example
Query
query GetSubscriptionList($body: SubscriptionListRq) {
getSubscriptionList(body: $body) {
data {
checkoutSessionUrl
consumers {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
currentPrice {
currency
price
}
endDate
energyAmountInWh
id
offers {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
...FileDTOFragment
}
pricePerWh
productType
tags
}
percentGreenGoal
preferences {
consumptionLocationStrict
consumptionTimeStrict
energyTypes
}
priorityList {
description
id
items {
...PriorityListItemDTOFragment
}
name
recSources {
...RecSourceDTOFragment
}
tags
}
startDate
status
}
pagination {
skip
take
total
}
}
}
Variables
{"body": SubscriptionListRq}
Response
{
"data": {
"getSubscriptionList": {
"data": [SubscriptionDTO],
"pagination": PaginationRs
}
}
}
getTenantFeatureLimitById
Description
Get tenant feature limits by ID. Returns current usage and limits for all features.
Response
Returns a TenantFeatureLimitDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetTenantFeatureLimitById($id: ID!) {
getTenantFeatureLimitById(id: $id) {
allocations {
limit
used
}
greenTariffs {
limit
used
}
internalConsumers {
limit
used
}
onsites {
limit
used
}
orders {
limit
used
}
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
ppas {
limit
used
}
proofs {
limit
used
}
redemptions {
limit
used
}
unbundled {
limit
used
}
valueChainConsumers {
limit
used
}
valueChainPartners {
limit
used
}
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getTenantFeatureLimitById": {
"allocations": FeatureLimitUsageDTO,
"greenTariffs": FeatureLimitUsageDTO,
"internalConsumers": FeatureLimitUsageDTO,
"onsites": FeatureLimitUsageDTO,
"orders": FeatureLimitUsageDTO,
"organization": OrganizationDTO,
"ppas": FeatureLimitUsageDTO,
"proofs": FeatureLimitUsageDTO,
"redemptions": FeatureLimitUsageDTO,
"unbundled": FeatureLimitUsageDTO,
"valueChainConsumers": FeatureLimitUsageDTO,
"valueChainPartners": FeatureLimitUsageDTO
}
}
}
getTenantPermissionById
Description
Get tenant permission by ID.
Response
Returns a TenantPermissionDTO
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetTenantPermissionById($id: ID!) {
getTenantPermissionById(id: $id) {
accessingTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
id
ownerTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
rights
type
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"getTenantPermissionById": {
"accessingTenant": OrganizationDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"ownerTenant": OrganizationDTO,
"rights": ["ALLOCATION"],
"type": "READ"
}
}
}
getTenantPermissionList
Description
Get a paginated list of tenant permissions with optional filtering.
Response
Returns a TenantPermissionListRs
Arguments
| Name | Description |
|---|---|
body - TenantPermissionListRq
|
Example
Query
query GetTenantPermissionList($body: TenantPermissionListRq) {
getTenantPermissionList(body: $body) {
data {
accessingTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
id
ownerTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
rights
type
}
pagination {
skip
take
total
}
}
}
Variables
{"body": TenantPermissionListRq}
Response
{
"data": {
"getTenantPermissionList": {
"data": [TenantPermissionDTO],
"pagination": PaginationRs
}
}
}
getUtilityAccountList
Description
Get a paginated list of utility accounts with optional filtering and sorting.
Response
Returns a UtilityAccountListRs
Arguments
| Name | Description |
|---|---|
body - UtilityAccountListRq!
|
Example
Query
query GetUtilityAccountList($body: UtilityAccountListRq!) {
getUtilityAccountList(body: $body) {
data {
bills
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
id
meters
status
}
pagination {
skip
take
total
}
}
}
Variables
{"body": UtilityAccountListRq}
Response
{
"data": {
"getUtilityAccountList": {
"data": [UtilityAccountDTO],
"pagination": PaginationRs
}
}
}
getW3BlockchainProperties
Description
Get blockchain properties with optional filtering.
Response
Returns a W3BlockchainPropertiesListRs
Arguments
| Name | Description |
|---|---|
body - W3BlockchainPropertiesGetRq
|
Example
Query
query GetW3BlockchainProperties($body: W3BlockchainPropertiesGetRq) {
getW3BlockchainProperties(body: $body) {
data {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
pagination {
skip
take
total
}
}
}
Variables
{"body": W3BlockchainPropertiesGetRq}
Response
{
"data": {
"getW3BlockchainProperties": {
"data": [W3BlockchainPropertiesDTO],
"pagination": PaginationRs
}
}
}
me
Description
Get current user information including MFA and verification status.
Response
Returns a UserInfoRs!
Example
Query
query Me {
me {
email
id
mfaEnabled
role
tenantId
verified
}
}
Response
{
"data": {
"me": {
"email": "some-email@example.org",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"mfaEnabled": false,
"role": "Auditor",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"verified": false
}
}
}
Mutations
cancelSubscription
Description
Cancel an active subscription. Restrictions:
- Only ACTIVE subscriptions can be cancelled
- Cannot cancel an already cancelled subscription
Response
Returns a SubscriptionStatus!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation CancelSubscription($id: ID!) {
cancelSubscription(id: $id)
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{"data": {"cancelSubscription": "ACTIVE"}}
changePassword
Description
Change user password.
Response
Returns a SuccessRs
Arguments
| Name | Description |
|---|---|
body - ChangePasswordRq!
|
Example
Query
mutation ChangePassword($body: ChangePasswordRq!) {
changePassword(body: $body) {
message
success
}
}
Variables
{"body": ChangePasswordRq}
Response
{
"data": {
"changePassword": {
"message": "abc123",
"success": false
}
}
}
claimCertificates
Description
Claim certificates for a consumption. Restrictions:
- Certificate must be in MINTED status if blockchain enabled or CREATED if disabled
- Each certificate must have sufficient open volume for the claimed amount
- Claims cannot be modified once made
Process:
- When blockchain is enabled:
- Processes claims asynchronously which can be monitored through certificate status
Response
Returns a ConsumptionDTO!
Arguments
| Name | Description |
|---|---|
body - ClaimCertificatesRq!
|
Example
Query
mutation ClaimCertificates($body: ClaimCertificatesRq!) {
claimCertificates(body: $body) {
certificates {
amountInWh
certificate {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
}
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
}
Variables
{"body": ClaimCertificatesRq}
Response
{
"data": {
"claimCertificates": {
"certificates": [CertificateClaimDTO],
"consumer": ConsumerDTO,
"decarbonizationStatus": "DECARBONIZED",
"deliveryPartners": [OrganizationDTO],
"deploymentStatus": "COMPLETED",
"documents": [FileDTO],
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"futureREC": true,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"measuringPartners": [OrganizationDTO],
"metadata": "abc123",
"percentGreenGoal": 42,
"reportingEndDate": "2022-12-31",
"reportingStartDate": "2022-01-01",
"startDate": "2022-01-01",
"visibility": "PRIVATE",
"w3Address": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3BuyerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3ClaimAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3DeployAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"w3FillAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3SellerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3SignAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
}
}
}
confirmPassword
Description
Confirm password change after reset.
Response
Returns a String
Arguments
| Name | Description |
|---|---|
body - ConfirmPasswordRq!
|
Example
Query
mutation ConfirmPassword($body: ConfirmPasswordRq!) {
confirmPassword(body: $body)
}
Variables
{"body": ConfirmPasswordRq}
Response
{"data": {"confirmPassword": "xyz789"}}
connectUtilityAccount
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
body - ConnectUtilityAccountRq!
|
Example
Query
mutation ConnectUtilityAccount($body: ConnectUtilityAccountRq!) {
connectUtilityAccount(body: $body)
}
Variables
{"body": ConnectUtilityAccountRq}
Response
{
"data": {
"connectUtilityAccount": "xyz789"
}
}
createCertificates
Description
Create one or more certificates. Important restrictions:
- Only SuperAdmin can create non-draft certificates
- Regular users can only create draft certificates (isDraft = true)
- ExternalId must be unique across all certificates
- Sum of recSourceDistributions energyAmountInWh must equal certificate energyAmountInWh
Response
Returns [CertificateDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateCertificatesRq!
|
Example
Query
mutation CreateCertificates($body: CreateCertificatesRq!) {
createCertificates(body: $body) {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
}
Variables
{"body": CreateCertificatesRq}
Response
{
"data": {
"createCertificates": [
{
"claimSingleEventResponses": [
ClaimSingleEventResponse
],
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"isGreenECertified": true,
"label": "SOME_LABEL",
"openVolumeInWh": "1000",
"productType": "EUGO",
"providerReferenceNumber": "xyz789",
"recSource": RecSourceDTO,
"recSourceDistributions": [
CertificateRecSourceDistributionDTO
],
"redemption": RedemptionDTO,
"status": "CREATED",
"supplier": OrganizationDTO,
"tenant": OrganizationDTO,
"w3Id": "xyz789",
"w3MintBlock": 42
}
]
}
}
createConsumers
Description
Create one or more consumers. Restrictions:
- External ID must be unique
Response
Returns [ConsumerDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateConsumersRq!
|
Example
Query
mutation CreateConsumers($body: CreateConsumersRq!) {
createConsumers(body: $body) {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
consumerFieldType
description
name
orderNumber
required
}
description
entityType
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{"body": CreateConsumersRq}
Response
{
"data": {
"createConsumers": [
{
"address": "Some Address 123",
"data": [ConsumerFieldDTO],
"deliveryPartners": [OrganizationDTO],
"description": "This is a description",
"documents": [FileDTO],
"emissionsFactor": ConsumerEmissionsFactorDTO,
"estimatedDailyConsumptionInWh": "abc123",
"estimatedMonthlyConsumptions": [
EstimatedMonthlyConsumptionDTO
],
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"latitude": "xyz789",
"location": LocationDTO,
"longitude": "abc123",
"measuringPartners": [OrganizationDTO],
"metadata": ConsumerMetadataDTO,
"name": "Some Name",
"organization": OrganizationDTO,
"percentGreenGoal": 42,
"priorityListIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"productType": "EUGO",
"tags": ["abc123"],
"tenant": OrganizationDTO
}
]
}
}
createConsumptions
Description
Create one or more consumptions. Restrictions:
- Date ranges cannot overlap with existing consumptions
- When visibility is PUBLIC, blockchain must be enabled
Process:
- Calculates reporting timeframe based on tenant settings reportingTimeframeToleranceInMonths
- For PUBLIC visibility, deploys blockchain agreement
- Creates proofs/proposals if enabled:
- Uses priority list items and available REC sources for automatic generation
- When setting triggerProofProposalAutomatically is true:
- Creates proof proposals if triggerProofInsteadOfProofProposalAutomatically is false
- Creates proofs directly if triggerProofInsteadOfProofProposalAutomatically is true
Response
Returns [ConsumptionDTO!]!
Arguments
| Name | Description |
|---|---|
body - CreateConsumptionsRq!
|
Example
Query
mutation CreateConsumptions($body: CreateConsumptionsRq!) {
createConsumptions(body: $body) {
certificates {
amountInWh
certificate {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
}
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
}
Variables
{"body": CreateConsumptionsRq}
Response
{
"data": {
"createConsumptions": [
{
"certificates": [CertificateClaimDTO],
"consumer": ConsumerDTO,
"decarbonizationStatus": "DECARBONIZED",
"deliveryPartners": [OrganizationDTO],
"deploymentStatus": "COMPLETED",
"documents": [FileDTO],
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"futureREC": false,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"measuringPartners": [OrganizationDTO],
"metadata": "xyz789",
"percentGreenGoal": 42,
"reportingEndDate": "2022-12-31",
"reportingStartDate": "2022-01-01",
"startDate": "2022-01-01",
"visibility": "PRIVATE",
"w3Address": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3BuyerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3ClaimAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3DeployAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"w3FillAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3SellerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3SignAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
}
]
}
}
createGenerators
Description
Create generators. Restrictions:
- Name must be unique
- externalId must be unique
- registryGeneratorId must be unique
- Valid ISO country code required
- Coordinates must be valid latitude/longitude
- Nameplate capacity must be positive
Response
Returns [GeneratorDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateGeneratorsRq!
|
Example
Query
mutation CreateGenerators($body: CreateGeneratorsRq!) {
createGenerators(body: $body) {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{"body": CreateGeneratorsRq}
Response
{
"data": {
"createGenerators": [
{
"commissioningDate": "2022-09-21",
"energySource": "BIOGAS",
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"impactStories": ["xyz789"],
"latitude": "abc123",
"links": ["abc123"],
"location": LocationDTO,
"longitude": "xyz789",
"name": "Some Name",
"nameplateCapacityInW": "Some Name",
"registryGeneratorId": "xyz789",
"support": "xyz789",
"tenant": OrganizationDTO
}
]
}
}
createOrganizations
Description
Create one or more organizations. Restrictions:
- Email and external ID must be unique across organizations
Response
Returns [OrganizationDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateOrganizationsRq!
|
Example
Query
mutation CreateOrganizations($body: CreateOrganizationsRq!) {
createOrganizations(body: $body) {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
numberOfConsumers
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
averageAmountInWh
energySourcesSummary {
...ProofEnergyTypeSummaryFragment
}
numberOfProofs
perYearSummary {
...AmountPerYearSummaryFragment
}
totalAmountInWh
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
Variables
{"body": CreateOrganizationsRq}
Response
{
"data": {
"createOrganizations": [
{
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "xyz789",
"colorSecondary": "abc123",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"inventoryIds": ["1_1"],
"isOrganizationAdminRegistered": true,
"isRecProvider": true,
"location": LocationDTO,
"logo": FileDTO,
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"onboardingPartnerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"partnershipText": "xyz789",
"publicEmail": "some-email@example.org",
"settings": TenantSettingsDTO,
"shortText": "abc123",
"social": "@SomeHandle",
"summary": OrganizationSummariesDTO,
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["abc123"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"vat": "abc123",
"website": "https://example.org",
"zip": "92704"
}
]
}
}
createPriorityListItems
Description
Create priority list items. Restrictions:
- Priority must be unique within list
- Cannot use both amount and percentage
- Consumer can only be on a single priority list item
Response
Returns [PriorityListItemDTO!]
Arguments
| Name | Description |
|---|---|
body - CreatePriorityListItemsRq!
|
Example
Query
mutation CreatePriorityListItems($body: CreatePriorityListItemsRq!) {
createPriorityListItems(body: $body) {
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
}
Variables
{"body": CreatePriorityListItemsRq}
Response
{
"data": {
"createPriorityListItems": [
{
"consumer": ConsumerDTO,
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"percentage": 42,
"priority": 42,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tags": ["abc123"]
}
]
}
}
createPriorityLists
Description
Create priority lists. Restrictions:
- Name must be unique
- REC sources can be only on a single priority list
Response
Returns [PriorityListDTO!]
Arguments
| Name | Description |
|---|---|
body - CreatePriorityListsRq!
|
Example
Query
mutation CreatePriorityLists($body: CreatePriorityListsRq!) {
createPriorityLists(body: $body) {
description
id
items {
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
name
recSources {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
tags
}
}
Variables
{"body": CreatePriorityListsRq}
Response
{
"data": {
"createPriorityLists": [
{
"description": "This is a description",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"items": [PriorityListItemDTO],
"name": "Some Name",
"recSources": [RecSourceDTO],
"tags": ["abc123"]
}
]
}
}
createProofProposals
Description
Create proof proposals. Restrictions:
- Certificates must have sufficient open volume
Response
Returns [ProofProposalDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateProofProposalsRq!
|
Example
Query
mutation CreateProofProposals($body: CreateProofProposalsRq!) {
createProofProposals(body: $body) {
certificateAmounts {
certificate {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
energyAmountInWh
}
consumption {
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
id
priorityListItem {
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
proof {
attestationUrl
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumption {
certificates {
...CertificateClaimDTOFragment
}
consumer {
...ConsumerDTOFragment
}
decarbonizationStatus
deliveryPartners {
...OrganizationDTOFragment
}
deploymentStatus
documents {
...FileDTOFragment
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
...OrganizationDTOFragment
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
creationDate
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
energyAmountInWh
energyTypes
generators {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
productTypes
suppliers {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
status
}
}
Variables
{"body": CreateProofProposalsRq}
Response
{
"data": {
"createProofProposals": [
{
"certificateAmounts": ["1000"],
"consumption": ConsumptionDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"priorityListItem": PriorityListItemDTO,
"proof": ProofDTO,
"status": "ACCEPTED"
}
]
}
}
createProofRequests
Description
Create one or more proof requests. Process:
- Calculates total amount/price based on consumption energy and price per Wh
- Generates Stripe checkout session for payment
- When checkout session is paid:
- Marks consumptions as future REC
- Updates payment status to PAID
Restrictions:
- Consumptions must not be included in other proof requests
- Must have matching offer available
Response
Returns [ProofRequestDTO!]!
Arguments
| Name | Description |
|---|---|
body - CreateProofRequestsRq!
|
Example
Query
mutation CreateProofRequests($body: CreateProofRequestsRq!) {
createProofRequests(body: $body) {
checkoutSessionUrl
consumptions {
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
id
offer {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
pricePerWh
productType
tags
}
paymentStatus
preferences {
consumptionLocationStrict
consumptionTimeStrict
energyTypes
}
status
tags
}
}
Variables
{"body": CreateProofRequestsRq}
Response
{
"data": {
"createProofRequests": [
{
"checkoutSessionUrl": "xyz789",
"consumptions": [ConsumptionDTO],
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"offer": OfferDTO,
"paymentStatus": "CANCELLED",
"preferences": MatchingPreferencesDTO,
"status": "FULFILLABLE",
"tags": ["abc123"]
}
]
}
}
createRecSources
Description
Create REC sources. Restrictions:
- End date must be after start date
- Order date must be before delivery date
- Either energyAmountInWh or energyAmountPercentage required, not both
- External ID must be unique
- Currency required if price is set
- For RECURRING deliveryType: recurringType and period required
- For ONE_TIME deliveryType: deliveryDate required
Response
Returns [RecSourceDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateRecSourcesRq!
|
Example
Query
mutation CreateRecSources($body: CreateRecSourcesRq!) {
createRecSources(body: $body) {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{"body": CreateRecSourcesRq}
Response
{
"data": {
"createRecSources": [
{
"currency": "abc123",
"deliveryDate": "2022-09-21",
"deliveryType": "ONE_TIME",
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"energyAmountPercentage": "1000",
"energySources": ["BIOGAS"],
"externalId": "SOME_EXTERNAL_ID-1234",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventory": W3BlockchainPropertiesDTO,
"label": "SOME_LABEL",
"locations": [LocationDTO],
"orderDate": "2022-09-21",
"pricePerWh": 123.45,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"productType": "EUGO",
"provider": OrganizationDTO,
"recurringDeliveryPeriod": "DAILY",
"recurringType": "GreenTariff",
"startDate": "2022-01-01",
"tenant": OrganizationDTO
}
]
}
}
createRedemptionShortText
Description
Create short text for redemption and upload to arweave. Can be triggeered only once.
Response
Returns a RedemptionDTO!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation CreateRedemptionShortText($id: String!) {
createRedemptionShortText(id: $id) {
certificates {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
...CertificateDTOFragment
}
comment
description
energyAmountInWh
fullText
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
mintCertificatesTxHash
name
protocolVersion
recSource {
...RecSourceDTOFragment
}
redemptionStatement {
...FileDTOFragment
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
...OrganizationDTOFragment
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"createRedemptionShortText": {
"certificates": [CertificateDTO],
"comment": "Some random comment",
"description": "This is a description",
"energyAmountInWh": "1000",
"fullText": "abc123",
"id": "0x0d63730e6522d34fb200e2399a262ef96cbf46ee8da762383111d1bcd200c752",
"inventory": W3BlockchainPropertiesDTO,
"mintCertificatesTxHash": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"name": "Some Name",
"protocolVersion": "abc123",
"recSource": RecSourceDTO,
"redemptionStatement": FileDTO,
"redemptionStatementBcStatus": "REDEMPTION_STATEMENT_NOT_SET",
"redemptionStatementTxBlock": 42,
"redemptionStatementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"registry": "xyz789",
"shortText": "xyz789",
"status": "APPROVED",
"storagePointer": "abc123",
"tags": ["xyz789"],
"tenant": OrganizationDTO,
"title": "This is a Title",
"trustLink": "ONE_DIRECTIONAL"
}
}
}
createRedemptions
Description
Create redemptions.
Process:
- When blockchain is enabled and redemption statement is provided:
- Sets redemptionStatementBcStatus status to REDEMPTION_STATEMENT_SET_REQUESTED
- Initiates async blockchain deployment
- Progress can be tracked through status changes
Restrictions:
- Name must be unique
- If REC source specified, dates must be within REC source period
Response
Returns [RedemptionDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateRedemptionsRq
|
Example
Query
mutation CreateRedemptions($body: CreateRedemptionsRq) {
createRedemptions(body: $body) {
certificates {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
...CertificateDTOFragment
}
comment
description
energyAmountInWh
fullText
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
mintCertificatesTxHash
name
protocolVersion
recSource {
...RecSourceDTOFragment
}
redemptionStatement {
...FileDTOFragment
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
...OrganizationDTOFragment
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
}
Variables
{"body": CreateRedemptionsRq}
Response
{
"data": {
"createRedemptions": [
{
"certificates": [CertificateDTO],
"comment": "Some random comment",
"description": "This is a description",
"energyAmountInWh": "1000",
"fullText": "abc123",
"id": "0x0d63730e6522d34fb200e2399a262ef96cbf46ee8da762383111d1bcd200c752",
"inventory": W3BlockchainPropertiesDTO,
"mintCertificatesTxHash": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"name": "Some Name",
"protocolVersion": "xyz789",
"recSource": RecSourceDTO,
"redemptionStatement": FileDTO,
"redemptionStatementBcStatus": "REDEMPTION_STATEMENT_NOT_SET",
"redemptionStatementTxBlock": 42,
"redemptionStatementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"registry": "xyz789",
"shortText": "xyz789",
"status": "APPROVED",
"storagePointer": "abc123",
"tags": ["abc123"],
"tenant": OrganizationDTO,
"title": "This is a Title",
"trustLink": "ONE_DIRECTIONAL"
}
]
}
}
createScope3Allocations
Description
Create Scope 3 allocations. Restrictions:
- End date must be after start date
- Dates cannot overlap with existing allocations for same consumer and organization
- Clean energy cannot exceed consumed energy
Response
Returns [Scope3AllocationDTO!]!
Arguments
| Name | Description |
|---|---|
body - CreateScope3AllocationsRq!
|
Example
Query
mutation CreateScope3Allocations($body: CreateScope3AllocationsRq!) {
createScope3Allocations(body: $body) {
cleanEnergyAmountInWh
consumedEnergyAmountInWh
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
endDate
id
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
startDate
}
}
Variables
{"body": CreateScope3AllocationsRq}
Response
{
"data": {
"createScope3Allocations": [
{
"cleanEnergyAmountInWh": "1000",
"consumedEnergyAmountInWh": "1000",
"consumer": ConsumerDTO,
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organization": OrganizationDTO,
"startDate": "2022-01-01"
}
]
}
}
createSubscriptions
Description
Create one or more subscriptions. Process:
- Creates subscription record
- Generates checkout URL
- When payment is completed:
- Creates recurring REC source for subscription period
- Creates priority list with all subscription consumers
- Sets subscription status to ACTIVE
Restrictions:
- Consumers cannot be in another active subscription
- Consumers should have the same productType
- All consumers must have consumptions
Response
Returns [SubscriptionDTO!]!
Arguments
| Name | Description |
|---|---|
body - CreateSubscriptionsRq!
|
Example
Query
mutation CreateSubscriptions($body: CreateSubscriptionsRq!) {
createSubscriptions(body: $body) {
checkoutSessionUrl
consumers {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
currentPrice {
currency
price
}
endDate
energyAmountInWh
id
offers {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
pricePerWh
productType
tags
}
percentGreenGoal
preferences {
consumptionLocationStrict
consumptionTimeStrict
energyTypes
}
priorityList {
description
id
items {
consumer {
...ConsumerDTOFragment
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
name
recSources {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
tags
}
startDate
status
}
}
Variables
{"body": CreateSubscriptionsRq}
Response
{
"data": {
"createSubscriptions": [
{
"checkoutSessionUrl": "abc123",
"consumers": [ConsumerDTO],
"currentPrice": SubscriptionPriceDTO,
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"offers": [OfferDTO],
"percentGreenGoal": 42,
"preferences": MatchingPreferencesDTO,
"priorityList": PriorityListDTO,
"startDate": "2022-01-01",
"status": "ACTIVE"
}
]
}
}
createTenant
Description
Create a new tenant organization with settings. Process:
- Initializes tenant settings
- Sets up blockchain configuration if enabled
Restrictions:
- Email and external ID must be unique across organizations
Response
Returns an OrganizationDTO
Arguments
| Name | Description |
|---|---|
body - CreateTenantRq!
|
Example
Query
mutation CreateTenant($body: CreateTenantRq!) {
createTenant(body: $body) {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
numberOfConsumers
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
averageAmountInWh
energySourcesSummary {
...ProofEnergyTypeSummaryFragment
}
numberOfProofs
perYearSummary {
...AmountPerYearSummaryFragment
}
totalAmountInWh
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
Variables
{"body": CreateTenantRq}
Response
{
"data": {
"createTenant": {
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "abc123",
"colorSecondary": "abc123",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"inventoryIds": ["1_1"],
"isOrganizationAdminRegistered": false,
"isRecProvider": false,
"location": LocationDTO,
"logo": FileDTO,
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"onboardingPartnerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"partnershipText": "xyz789",
"publicEmail": "some-email@example.org",
"settings": TenantSettingsDTO,
"shortText": "xyz789",
"social": "@SomeHandle",
"summary": OrganizationSummariesDTO,
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["abc123"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"vat": "xyz789",
"website": "https://example.org",
"zip": "92704"
}
}
}
createTenantPermissions
Description
Create tenant permissions.
Response
Returns [TenantPermissionDTO!]
Arguments
| Name | Description |
|---|---|
body - CreateTenantPermissionsRq!
|
Example
Query
mutation CreateTenantPermissions($body: CreateTenantPermissionsRq!) {
createTenantPermissions(body: $body) {
accessingTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
id
ownerTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
rights
type
}
}
Variables
{"body": CreateTenantPermissionsRq}
Response
{
"data": {
"createTenantPermissions": [
{
"accessingTenant": OrganizationDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"ownerTenant": OrganizationDTO,
"rights": ["ALLOCATION"],
"type": "READ"
}
]
}
}
deletePriorityList
Description
Delete priority list. Restrictions:
- Cannot delete lists with active proposals or subscriptions
Example
Query
mutation DeletePriorityList($id: ID!) {
deletePriorityList(id: $id) {
message
success
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"deletePriorityList": {
"message": "abc123",
"success": true
}
}
}
deletePriorityListItem
Description
Delete priority list item. Restrictions:
- Cannot delete items with active proposals
Example
Query
mutation DeletePriorityListItem($id: ID!) {
deletePriorityListItem(id: $id) {
message
success
}
}
Variables
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Response
{
"data": {
"deletePriorityListItem": {
"message": "abc123",
"success": true
}
}
}
disableMfa
Description
Disable MFA.
Response
Returns a SuccessRs
Example
Query
mutation DisableMfa {
disableMfa {
message
success
}
}
Response
{
"data": {
"disableMfa": {
"message": "xyz789",
"success": false
}
}
}
disconnectUtilityAccount
Response
Returns a SuccessRs!
Arguments
| Name | Description |
|---|---|
body - DisconnectUtilityAccountRq!
|
Example
Query
mutation DisconnectUtilityAccount($body: DisconnectUtilityAccountRq!) {
disconnectUtilityAccount(body: $body) {
message
success
}
}
Variables
{"body": DisconnectUtilityAccountRq}
Response
{
"data": {
"disconnectUtilityAccount": {
"message": "xyz789",
"success": true
}
}
}
forgotPassword
Description
Initiate password reset.
Example
Query
mutation ForgotPassword($email: String!) {
forgotPassword(email: $email) {
message
success
}
}
Variables
{"email": "some-email@example.org"}
Response
{
"data": {
"forgotPassword": {
"message": "abc123",
"success": false
}
}
}
generateProofProposals
Description
Generate proof proposals for a priority list.
Response
Returns [ID]
Arguments
| Name | Description |
|---|---|
body - GenerateProofProposalsRq!
|
Example
Query
mutation GenerateProofProposals($body: GenerateProofProposalsRq!) {
generateProofProposals(body: $body)
}
Variables
{"body": GenerateProofProposalsRq}
Response
{
"data": {
"generateProofProposals": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
]
}
}
generateProofs
Description
Generate proofs based on priority list item.
Response
Returns [ID]
Arguments
| Name | Description |
|---|---|
body - GenerateProofProposalsRq!
|
Example
Query
mutation GenerateProofs($body: GenerateProofProposalsRq!) {
generateProofs(body: $body)
}
Variables
{"body": GenerateProofProposalsRq}
Response
{
"data": {
"generateProofs": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
]
}
}
generateTOTPKey
Description
Generate new TOTP key for MFA setup.
Response
Returns a String
Example
Query
mutation GenerateTOTPKey {
generateTOTPKey
}
Response
{"data": {"generateTOTPKey": "xyz789"}}
handoverOrganization
Description
Initiate the organization handover, granting user full control of the organization. Process:
- Creates handover token
- Token is used during registration to assign role and tenant
Response
Returns a HandoverOrganizationDTO
Arguments
| Name | Description |
|---|---|
body - HandoverOrganizationRq!
|
Example
Query
mutation HandoverOrganization($body: HandoverOrganizationRq!) {
handoverOrganization(body: $body) {
token
}
}
Variables
{"body": HandoverOrganizationRq}
Response
{
"data": {
"handoverOrganization": {
"token": "xyz789"
}
}
}
inviteAuditor
Description
Invite auditor. Process:
- Creates invitation with token
- Sends invitation email
- Token is used during registration to assign role and tenant
Response
Returns a UserInvitationDTO
Arguments
| Name | Description |
|---|---|
body - InviteAuditorRq!
|
Example
Query
mutation InviteAuditor($body: InviteAuditorRq!) {
inviteAuditor(body: $body) {
email
tenantId
token
}
}
Variables
{"body": InviteAuditorRq}
Response
{
"data": {
"inviteAuditor": {
"email": "some-email@example.org",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"token": "abc123"
}
}
}
inviteOrganizationAdmin
Description
Invite new user as an organization admin. Process:
- Creates invitation with token
- Token is used during registration to assign role and tenant
Parameters:
- email: Email of the user to invite
- tenantId: Optional tenant ID (uses current tenant if not provided)
- newTenant: If true, assigns the user to a new tenant. If false, assigns the user to existing tenant
Response
Returns a UserInvitationDTO
Arguments
| Name | Description |
|---|---|
body - InviteOrganizationAdminRq!
|
Example
Query
mutation InviteOrganizationAdmin($body: InviteOrganizationAdminRq!) {
inviteOrganizationAdmin(body: $body) {
email
tenantId
token
}
}
Variables
{"body": InviteOrganizationAdminRq}
Response
{
"data": {
"inviteOrganizationAdmin": {
"email": "some-email@example.org",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"token": "abc123"
}
}
}
login
Description
Login with email and password. Process:
- Validates credentials
- Requires MFA code if enabled
- Returns tokens for authentication
Example
Query
mutation Login($body: LoginRq!) {
login(body: $body) {
accessToken {
accessToken
expires
}
idToken
refreshToken
}
}
Variables
{"body": LoginRq}
Response
{
"data": {
"login": {
"accessToken": AccessTokenRs,
"idToken": "abc123",
"refreshToken": "abc123"
}
}
}
loginSso
Description
Initiate SSO login flow. Returns redirect URL for SSO provider.
loginSsoCallback
Description
Complete SSO login flow. Process:
- Validates SSO callback
- Returns tokens for authentication
Response
Returns a LoginRs
Arguments
| Name | Description |
|---|---|
body - LoginSsoCallbackRq!
|
Example
Query
mutation LoginSsoCallback($body: LoginSsoCallbackRq!) {
loginSsoCallback(body: $body) {
accessToken {
accessToken
expires
}
idToken
refreshToken
}
}
Variables
{"body": LoginSsoCallbackRq}
Response
{
"data": {
"loginSsoCallback": {
"accessToken": AccessTokenRs,
"idToken": "xyz789",
"refreshToken": "abc123"
}
}
}
makePublic
Description
Make a consumption public and deploy it on blockchain. Used for FutuREC after certificates have been minted Restrictions:
- Cannot be used if blockchain is disabled
- Cannot make an already public consumption public
Process:
- Deploys consumption to blockchain
- Blockchain deployment progress can be tracked via deploymentStatus field
parseWithAI
Description
Parse file content using AI. Process:
- Submits file for AI processing
- Creates an AI task that can be tracked
- Progress can be monitored via task status
Restrictions:
- File type must have a valid prompt
Response
Returns an AITaskDTO
Arguments
| Name | Description |
|---|---|
body - AIParseRq!
|
Example
Query
mutation ParseWithAI($body: AIParseRq!) {
parseWithAI(body: $body) {
correctedResult
error
file {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
id
result
status
tags
}
}
Variables
{"body": AIParseRq}
Response
{
"data": {
"parseWithAI": {
"correctedResult": {},
"error": "xyz789",
"file": FileDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"result": {},
"status": "COMPLETED",
"tags": ["abc123"]
}
}
}
refreshApiKey
Response
Returns a RefreshApiKeyRs
Arguments
| Name | Description |
|---|---|
body - RefreshApiKeyRq!
|
Example
Query
mutation RefreshApiKey($body: RefreshApiKeyRq!) {
refreshApiKey(body: $body) {
apiKey
}
}
Variables
{"body": RefreshApiKeyRq}
Response
{
"data": {
"refreshApiKey": {"apiKey": "xyz789"}
}
}
register
Description
Register a new user. Verification not required if using invitation or handover token. Restrictions:
- Email must be unique
- Password must meet strength requirements
- Passwords must match
Response
Returns a SuccessRs
Arguments
| Name | Description |
|---|---|
body - RegisterRq!
|
Example
Query
mutation Register($body: RegisterRq!) {
register(body: $body) {
message
success
}
}
Variables
{"body": RegisterRq}
Response
{
"data": {
"register": {
"message": "abc123",
"success": true
}
}
}
replyToProofProposals
Description
Accept or reject proof proposals. Process:
- Accepting creates proofs
- Rejecting marks proposal as rejected
Restrictions:
- Can only reply to PENDING proposals
- Decision cannot be changed once made
Response
Returns [ProofProposalDTO!]
Arguments
| Name | Description |
|---|---|
body - ReplyToProofProposalsRq!
|
Example
Query
mutation ReplyToProofProposals($body: ReplyToProofProposalsRq!) {
replyToProofProposals(body: $body) {
certificateAmounts {
certificate {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
energyAmountInWh
}
consumption {
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
id
priorityListItem {
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
proof {
attestationUrl
certificates {
amountInWh
certificate {
...CertificateDTOFragment
}
}
consumption {
certificates {
...CertificateClaimDTOFragment
}
consumer {
...ConsumerDTOFragment
}
decarbonizationStatus
deliveryPartners {
...OrganizationDTOFragment
}
deploymentStatus
documents {
...FileDTOFragment
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
...OrganizationDTOFragment
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
creationDate
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
energyAmountInWh
energyTypes
generators {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
productTypes
suppliers {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
status
}
}
Variables
{"body": ReplyToProofProposalsRq}
Response
{
"data": {
"replyToProofProposals": [
{
"certificateAmounts": ["1000"],
"consumption": ConsumptionDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"priorityListItem": PriorityListItemDTO,
"proof": ProofDTO,
"status": "ACCEPTED"
}
]
}
}
updateCertificates
Description
Update one or more certificates. Important restrictions:
- Only SuperAdmin can update non-draft certificates
- Only SuperAdmin can mark certificates as created (markAsCreated = true)
- Once a certificate is no longer in DRAFT status, only recSourceDistributions can be updated
- ExternalId must remain unique across all certificates
- Sum of recSourceDistributions energyAmountInWh must equal certificate energyAmountInWh
Response
Returns [CertificateDTO!]!
Arguments
| Name | Description |
|---|---|
body - UpdateCertificatesRq!
|
Example
Query
mutation UpdateCertificates($body: UpdateCertificatesRq!) {
updateCertificates(body: $body) {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
}
Variables
{"body": UpdateCertificatesRq}
Response
{
"data": {
"updateCertificates": [
{
"claimSingleEventResponses": [
ClaimSingleEventResponse
],
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"isGreenECertified": false,
"label": "SOME_LABEL",
"openVolumeInWh": "1000",
"productType": "EUGO",
"providerReferenceNumber": "xyz789",
"recSource": RecSourceDTO,
"recSourceDistributions": [
CertificateRecSourceDistributionDTO
],
"redemption": RedemptionDTO,
"status": "CREATED",
"supplier": OrganizationDTO,
"tenant": OrganizationDTO,
"w3Id": "abc123",
"w3MintBlock": 42
}
]
}
}
updateConsumers
Description
Update existing consumers. Restrictions:
- External ID must be unique
- estimatedDailyConsumptionInWh can only be updated when there is no consumptions
Response
Returns [ConsumerDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdateConsumersRq!
|
Example
Query
mutation UpdateConsumers($body: UpdateConsumersRq!) {
updateConsumers(body: $body) {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
consumerFieldType
description
name
orderNumber
required
}
description
entityType
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{"body": UpdateConsumersRq}
Response
{
"data": {
"updateConsumers": [
{
"address": "Some Address 123",
"data": [ConsumerFieldDTO],
"deliveryPartners": [OrganizationDTO],
"description": "This is a description",
"documents": [FileDTO],
"emissionsFactor": ConsumerEmissionsFactorDTO,
"estimatedDailyConsumptionInWh": "abc123",
"estimatedMonthlyConsumptions": [
EstimatedMonthlyConsumptionDTO
],
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"latitude": "xyz789",
"location": LocationDTO,
"longitude": "xyz789",
"measuringPartners": [OrganizationDTO],
"metadata": ConsumerMetadataDTO,
"name": "Some Name",
"organization": OrganizationDTO,
"percentGreenGoal": 42,
"priorityListIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"productType": "EUGO",
"tags": ["abc123"],
"tenant": OrganizationDTO
}
]
}
}
updateConsumptions
Description
Update consumptions. Restrictions:
- Only SuperAdmin can update energyAmountInWh
- Cannot change visibility from PUBLIC to PRIVATE
- Updated dates cannot overlap with other consumptions
Response
Returns [ConsumptionDTO!]!
Arguments
| Name | Description |
|---|---|
body - UpdateConsumptionsRq!
|
Example
Query
mutation UpdateConsumptions($body: UpdateConsumptionsRq!) {
updateConsumptions(body: $body) {
certificates {
amountInWh
certificate {
claimSingleEventResponses {
...ClaimSingleEventResponseFragment
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
...GeneratorDTOFragment
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
...RecSourceDTOFragment
}
recSourceDistributions {
...CertificateRecSourceDistributionDTOFragment
}
redemption {
...RedemptionDTOFragment
}
status
supplier {
...OrganizationDTOFragment
}
tenant {
...OrganizationDTOFragment
}
w3Id
w3MintBlock
}
}
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
decarbonizationStatus
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
deploymentStatus
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
endDate
energyAmountInWh
externalId
futureREC
id
label
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata
percentGreenGoal
reportingEndDate
reportingStartDate
startDate
visibility
w3Address
w3BuyerAddress
w3ClaimAgreementTxHashList
w3DeployAgreementTxHash
w3FillAgreementTxHashList
w3SellerAddress
w3SignAgreementTxHash
}
}
Variables
{"body": UpdateConsumptionsRq}
Response
{
"data": {
"updateConsumptions": [
{
"certificates": [CertificateClaimDTO],
"consumer": ConsumerDTO,
"decarbonizationStatus": "DECARBONIZED",
"deliveryPartners": [OrganizationDTO],
"deploymentStatus": "COMPLETED",
"documents": [FileDTO],
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"futureREC": true,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"measuringPartners": [OrganizationDTO],
"metadata": "abc123",
"percentGreenGoal": 42,
"reportingEndDate": "2022-12-31",
"reportingStartDate": "2022-01-01",
"startDate": "2022-01-01",
"visibility": "PRIVATE",
"w3Address": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3BuyerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3ClaimAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3DeployAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"w3FillAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3SellerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3SignAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
}
]
}
}
updateGenerators
Description
Update generators.
Response
Returns [GeneratorDTO!]!
Arguments
| Name | Description |
|---|---|
body - UpdateGeneratorsRq!
|
Example
Query
mutation UpdateGenerators($body: UpdateGeneratorsRq!) {
updateGenerators(body: $body) {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{"body": UpdateGeneratorsRq}
Response
{
"data": {
"updateGenerators": [
{
"commissioningDate": "2022-09-21",
"energySource": "BIOGAS",
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"impactStories": ["abc123"],
"latitude": "abc123",
"links": ["xyz789"],
"location": LocationDTO,
"longitude": "abc123",
"name": "Some Name",
"nameplateCapacityInW": "Some Name",
"registryGeneratorId": "abc123",
"support": "xyz789",
"tenant": OrganizationDTO
}
]
}
}
updateOrganizations
Description
Update organizations. Restrictions:
- Email and external ID must remain unique across organizations
Response
Returns [OrganizationDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdateOrganizationsRq!
|
Example
Query
mutation UpdateOrganizations($body: UpdateOrganizationsRq!) {
updateOrganizations(body: $body) {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
numberOfConsumers
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
averageAmountInWh
energySourcesSummary {
...ProofEnergyTypeSummaryFragment
}
numberOfProofs
perYearSummary {
...AmountPerYearSummaryFragment
}
totalAmountInWh
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
Variables
{"body": UpdateOrganizationsRq}
Response
{
"data": {
"updateOrganizations": [
{
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "abc123",
"colorSecondary": "abc123",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "xyz789",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"inventoryIds": ["1_1"],
"isOrganizationAdminRegistered": true,
"isRecProvider": false,
"location": LocationDTO,
"logo": FileDTO,
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"onboardingPartnerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"partnershipText": "abc123",
"publicEmail": "some-email@example.org",
"settings": TenantSettingsDTO,
"shortText": "abc123",
"social": "@SomeHandle",
"summary": OrganizationSummariesDTO,
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["abc123"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"vat": "abc123",
"website": "https://example.org",
"zip": "92704"
}
]
}
}
updatePriorityListItems
Description
Update priority list items.
Response
Returns [PriorityListItemDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdatePriorityListItemsRq!
|
Example
Query
mutation UpdatePriorityListItems($body: UpdatePriorityListItemsRq!) {
updatePriorityListItems(body: $body) {
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
}
Variables
{"body": UpdatePriorityListItemsRq}
Response
{
"data": {
"updatePriorityListItems": [
{
"consumer": ConsumerDTO,
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"percentage": 42,
"priority": 42,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tags": ["abc123"]
}
]
}
}
updatePriorityLists
Description
Update priority lists.
Response
Returns [PriorityListDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdatePriorityListsRq!
|
Example
Query
mutation UpdatePriorityLists($body: UpdatePriorityListsRq!) {
updatePriorityLists(body: $body) {
description
id
items {
consumer {
address
data {
...ConsumerFieldDTOFragment
}
deliveryPartners {
...OrganizationDTOFragment
}
description
documents {
...FileDTOFragment
}
emissionsFactor {
...ConsumerEmissionsFactorDTOFragment
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
...EstimatedMonthlyConsumptionDTOFragment
}
externalId
id
images {
...FileDTOFragment
}
latitude
location {
...LocationDTOFragment
}
longitude
measuringPartners {
...OrganizationDTOFragment
}
metadata {
...ConsumerMetadataDTOFragment
}
name
organization {
...OrganizationDTOFragment
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
...OrganizationDTOFragment
}
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
name
recSources {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
tags
}
}
Variables
{"body": UpdatePriorityListsRq}
Response
{
"data": {
"updatePriorityLists": [
{
"description": "This is a description",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"items": [PriorityListItemDTO],
"name": "Some Name",
"recSources": [RecSourceDTO],
"tags": ["xyz789"]
}
]
}
}
updateRecSources
Description
Update REC sources. Restrictions:
- End date must be after start date if provided
- Cannot update to have both amount types
- Currency required if updating price
Response
Returns [RecSourceDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdateRecSourcesRq!
|
Example
Query
mutation UpdateRecSources($body: UpdateRecSourcesRq!) {
updateRecSources(body: $body) {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
impactStories
latitude
links
location {
country
region
state
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
}
}
Variables
{"body": UpdateRecSourcesRq}
Response
{
"data": {
"updateRecSources": [
{
"currency": "xyz789",
"deliveryDate": "2022-09-21",
"deliveryType": "ONE_TIME",
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"energyAmountPercentage": "1000",
"energySources": ["BIOGAS"],
"externalId": "SOME_EXTERNAL_ID-1234",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventory": W3BlockchainPropertiesDTO,
"label": "SOME_LABEL",
"locations": [LocationDTO],
"orderDate": "2022-09-21",
"pricePerWh": 123.45,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"productType": "EUGO",
"provider": OrganizationDTO,
"recurringDeliveryPeriod": "DAILY",
"recurringType": "GreenTariff",
"startDate": "2022-01-01",
"tenant": OrganizationDTO
}
]
}
}
updateRedemptions
Description
Update redemptions.
Process:
- Updates redemption details
- When redemption statement is provided:
- Validates file type is RedemptionStatement
- Sets TrustLink based on content:
- TWO_DIRECTIONAL if redemption ID is found in statement text
- ONE_DIRECTIONAL if redemption ID is not found
- If blockchain enabled, triggers deployment process
Response
Returns [RedemptionDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdateRedemptionsRq
|
Example
Query
mutation UpdateRedemptions($body: UpdateRedemptionsRq) {
updateRedemptions(body: $body) {
certificates {
claimSingleEventResponses {
blockNumber
certificateId
claimData
claimIssuer
claimSubject
claimedValue
topic
txHash
web3Id
}
energyAmountInWh
externalId
generationEnd
generationStart
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
isGreenECertified
label
openVolumeInWh
productType
providerReferenceNumber
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
recSourceDistributions {
energyAmountInWh
recSourceId
}
redemption {
certificates {
...CertificateDTOFragment
}
comment
description
energyAmountInWh
fullText
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
mintCertificatesTxHash
name
protocolVersion
recSource {
...RecSourceDTOFragment
}
redemptionStatement {
...FileDTOFragment
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
...OrganizationDTOFragment
}
title
trustLink
}
status
supplier {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
w3Id
w3MintBlock
}
comment
description
energyAmountInWh
fullText
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
mintCertificatesTxHash
name
protocolVersion
recSource {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
commissioningDate
energySource
externalId
id
images {
...FileDTOFragment
}
impactStories
latitude
links
location {
...LocationDTOFragment
}
longitude
name
nameplateCapacityInW
registryGeneratorId
support
tenant {
...OrganizationDTOFragment
}
}
id
inventory {
agreementFactory
agreementFactoryDeployTransaction
batchFactory
batchFactoryDeployTransaction
default
inventoryId
lowBalanceThreshold
netId
networkBlockExplorerUrl
networkName
platformOperatorBlockchainAddress
protocolVersion
registry
registryDeployTransaction
rpcNode
topic
}
label
locations {
country
region
state
}
orderDate
pricePerWh
priorityListId
productType
provider {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
redemptionStatement {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
redemptionStatementBcStatus
redemptionStatementTxBlock
redemptionStatementTxHash
registry
shortText
status
storagePointer
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
title
trustLink
}
}
Variables
{"body": UpdateRedemptionsRq}
Response
{
"data": {
"updateRedemptions": [
{
"certificates": [CertificateDTO],
"comment": "Some random comment",
"description": "This is a description",
"energyAmountInWh": "1000",
"fullText": "abc123",
"id": "0x0d63730e6522d34fb200e2399a262ef96cbf46ee8da762383111d1bcd200c752",
"inventory": W3BlockchainPropertiesDTO,
"mintCertificatesTxHash": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"name": "Some Name",
"protocolVersion": "xyz789",
"recSource": RecSourceDTO,
"redemptionStatement": FileDTO,
"redemptionStatementBcStatus": "REDEMPTION_STATEMENT_NOT_SET",
"redemptionStatementTxBlock": 42,
"redemptionStatementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"registry": "xyz789",
"shortText": "xyz789",
"status": "APPROVED",
"storagePointer": "abc123",
"tags": ["abc123"],
"tenant": OrganizationDTO,
"title": "This is a Title",
"trustLink": "ONE_DIRECTIONAL"
}
]
}
}
updateScope3Allocations
Description
Update Scope 3 allocations. Restrictions:
- energy amounts can only be increased
Response
Returns [Scope3AllocationDTO!]!
Arguments
| Name | Description |
|---|---|
body - UpdateScope3AllocationsRq!
|
Example
Query
mutation UpdateScope3Allocations($body: UpdateScope3AllocationsRq!) {
updateScope3Allocations(body: $body) {
cleanEnergyAmountInWh
consumedEnergyAmountInWh
consumer {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
endDate
id
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
startDate
}
}
Variables
{"body": UpdateScope3AllocationsRq}
Response
{
"data": {
"updateScope3Allocations": [
{
"cleanEnergyAmountInWh": "1000",
"consumedEnergyAmountInWh": "1000",
"consumer": ConsumerDTO,
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organization": OrganizationDTO,
"startDate": "2022-01-01"
}
]
}
}
updateSubscription
Description
Update subscription details. Restrictions:
- Cannot modify ACTIVE or EXPIRED subscriptions
Response
Returns a SubscriptionDTO
Arguments
| Name | Description |
|---|---|
body - UpdateSubscriptionRq!
|
Example
Query
mutation UpdateSubscription($body: UpdateSubscriptionRq!) {
updateSubscription(body: $body) {
checkoutSessionUrl
consumers {
address
data {
consumerFieldType
description
name
orderNumber
required
value
}
deliveryPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
description
documents {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
emissionsFactor {
unit
value
}
estimatedDailyConsumptionInWh
estimatedMonthlyConsumptions {
energyAmountInWh
month
}
externalId
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
latitude
location {
country
region
state
}
longitude
measuringPartners {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
metadata {
data {
...ConsumerMetadataFieldDTOFragment
}
description
entityType
id
images {
...FileDTOFragment
}
name
tenantId
}
name
organization {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
percentGreenGoal
priorityListIds
productType
tags
tenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
...FileDTOFragment
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
...LocationDTOFragment
}
logo {
...FileDTOFragment
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
...TenantSettingsDTOFragment
}
shortText
social
summary {
...OrganizationSummariesDTOFragment
}
supplierIds
tags
tenantId
vat
website
zip
}
}
currentPrice {
currency
price
}
endDate
energyAmountInWh
id
offers {
availableCertificateEnergyAmountInWh
availableOrderEnergyAmountInWh
currency
id
image {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
pricePerWh
productType
tags
}
percentGreenGoal
preferences {
consumptionLocationStrict
consumptionTimeStrict
energyTypes
}
priorityList {
description
id
items {
consumer {
...ConsumerDTOFragment
}
energyAmountInWh
id
percentage
priority
priorityListId
tags
}
name
recSources {
currency
deliveryDate
deliveryType
endDate
energyAmountInWh
energyAmountPercentage
energySources
externalId
generator {
...GeneratorDTOFragment
}
id
inventory {
...W3BlockchainPropertiesDTOFragment
}
label
locations {
...LocationDTOFragment
}
orderDate
pricePerWh
priorityListId
productType
provider {
...OrganizationDTOFragment
}
recurringDeliveryPeriod
recurringType
startDate
tenant {
...OrganizationDTOFragment
}
}
tags
}
startDate
status
}
}
Variables
{"body": UpdateSubscriptionRq}
Response
{
"data": {
"updateSubscription": {
"checkoutSessionUrl": "abc123",
"consumers": [ConsumerDTO],
"currentPrice": SubscriptionPriceDTO,
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"offers": [OfferDTO],
"percentGreenGoal": 42,
"preferences": MatchingPreferencesDTO,
"priorityList": PriorityListDTO,
"startDate": "2022-01-01",
"status": "ACTIVE"
}
}
}
updateTenantPermissions
Description
Update tenant permissions.
Response
Returns [TenantPermissionDTO!]
Arguments
| Name | Description |
|---|---|
body - UpdateTenantPermissionsRq!
|
Example
Query
mutation UpdateTenantPermissions($body: UpdateTenantPermissionsRq!) {
updateTenantPermissions(body: $body) {
accessingTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
id
ownerTenant {
address
blockchainAddress
city
colorPrimary
colorSecondary
companyName
customerIds
description
email
externalId
goals
id
images {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
inventoryIds
isOrganizationAdminRegistered
isRecProvider
location {
country
region
state
}
logo {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
mainCommercialContactEmail
mainCommercialContactName
mainTechnicalContactEmail
mainTechnicalContactName
name
onboardingPartnerId
partnershipText
publicEmail
settings {
blockchainEnabled
defaultCurrency
onboardingMode
pagesHiddenFromPublic
percentGreenGoal
reportingTimeframeToleranceInMonths
triggerProofInsteadOfProofProposalAutomatically
triggerProofProposalAutomatically
}
shortText
social
summary {
consumers {
...ConsumerSummaryDTOFragment
}
numberOfCertificates
numberOfProofRequests
numberOfRedemptions
proofs {
...ProofSummaryDTOFragment
}
}
supplierIds
tags
tenantId
vat
website
zip
}
rights
type
}
}
Variables
{"body": UpdateTenantPermissionsRq}
Response
{
"data": {
"updateTenantPermissions": [
{
"accessingTenant": OrganizationDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"ownerTenant": OrganizationDTO,
"rights": ["ALLOCATION"],
"type": "READ"
}
]
}
}
verifyAITaskResult
Description
Veriffy/train AI with corrected results. Process:
- Updates the task with corrected data
Restrictions:
- Task must be in COMPLETED status
- Cannot verify already verified tasks
Response
Returns an AITaskDTO
Arguments
| Name | Description |
|---|---|
body - VerifyAITaskResultRq!
|
Example
Query
mutation VerifyAITaskResult($body: VerifyAITaskResultRq!) {
verifyAITaskResult(body: $body) {
correctedResult
error
file {
arweaveTransactionId
fileType
id
ipfsCid
tenantId
url
}
id
result
status
tags
}
}
Variables
{"body": VerifyAITaskResultRq}
Response
{
"data": {
"verifyAITaskResult": {
"correctedResult": {},
"error": "xyz789",
"file": FileDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"result": {},
"status": "COMPLETED",
"tags": ["abc123"]
}
}
}
verifyAndEnableMfa
Description
Verify and enable MFA.
Example
Query
mutation VerifyAndEnableMfa($mfaCode: String!) {
verifyAndEnableMfa(mfaCode: $mfaCode) {
message
success
}
}
Variables
{"mfaCode": "abc123"}
Response
{
"data": {
"verifyAndEnableMfa": {
"message": "xyz789",
"success": true
}
}
}
verifyEmail
Description
Verify email address using verification code. Restrictions:
- Code must be valid and not expired
Response
Returns a SuccessRs
Arguments
| Name | Description |
|---|---|
body - VerifyEmailRq!
|
Example
Query
mutation VerifyEmail($body: VerifyEmailRq!) {
verifyEmail(body: $body) {
message
success
}
}
Variables
{"body": VerifyEmailRq}
Response
{
"data": {
"verifyEmail": {
"message": "xyz789",
"success": true
}
}
}
Types
AIModelType
Description
Available AI model types. Currently supports:
- GPT_4: Latest GPT-4 model
Values
| Enum Value | Description |
|---|---|
|
|
Example
"GPT_4"
AIParseRq
Description
Request to parse a file with AI. Restrictions:
- File must exist and be accessible
- Model must support the file type
- If promptVersion is not provided, the latest version of the prompt will be used
Fields
| Input Field | Description |
|---|---|
fileId - ID!
|
|
model - AIModelType!
|
|
promptVersion - Int
|
|
submissionToken - ID!
|
|
tags - [String]
|
Example
{
"fileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"model": "GPT_4",
"promptVersion": 42,
"submissionToken": "1699281292576:9a0b3ff48b",
"tags": ["abc123"]
}
AIPromptFiltersRq
Fields
| Input Field | Description |
|---|---|
fileType - FileType
|
|
latest - Boolean
|
|
model - AIModelType
|
|
version - Int
|
Example
{"fileType": "ConsumerImage", "latest": true, "model": "GPT_4", "version": 42}
AITaskDTO
Example
{
"correctedResult": {},
"error": "xyz789",
"file": FileDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"result": {},
"status": "COMPLETED",
"tags": ["xyz789"]
}
AITaskFiltersRq
Fields
| Input Field | Description |
|---|---|
file - FileFiltersRq
|
|
id - ID
|
|
prompt - AIPromptFiltersRq
|
|
status - AITaskStatus
|
|
tags - [String]
|
Example
{
"file": FileFiltersRq,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"prompt": AIPromptFiltersRq,
"status": "COMPLETED",
"tags": ["xyz789"]
}
AITaskListRq
Fields
| Input Field | Description |
|---|---|
filters - AITaskFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": AITaskFiltersRq,
"pagination": PaginationRq
}
AITaskListRs
Fields
| Field Name | Description |
|---|---|
data - [AITaskDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [AITaskDTO],
"pagination": PaginationRs
}
AITaskStatus
Description
Status of an AI parsing task. States:
- PENDING: Task created but not yet started
- IN_PROGRESS: AI is currently processing the file
- COMPLETED: Processing finished successfully
- ERROR: Processing failed with error
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
AccessTokenRs
AgreementDeploymentStatus
Description
Status of a consumption's blockchain agreement deployment. Process flow:
- DEPLOY_ON_WEB3_REQUESTED: Initial deployment request sent
- DEPLOYED_ON_WEB3: Smart contract successfully deployed
- SIGN_ON_WEB3_REQUESTED: Awaiting signature from parties
- SIGNED_ON_WEB3: Agreement signed by all parties
- CLAIMING_ON_CHAIN: Certificate claiming in progress
- COMPLETED: All blockchain operations finished
- ERROR: Error occurred during blockchain operations
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLAIMING_ON_CHAIN"
AmountPerYearSummary
AverageCalculationRq
Fields
| Input Field | Description |
|---|---|
endDate - String!
|
|
energyAmountInWh - String!
|
|
period - RecurringTimePeriod!
|
|
startDate - String!
|
Example
{
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"period": "DAILY",
"startDate": "2022-01-01"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CalculateConsumerEstimatedCleanRq
CalculateScope3AllocationAmountsRq
CalculateSubscriptionPriceRq
Fields
| Input Field | Description |
|---|---|
consumerIds - [String!]!
|
|
endDate - String!
|
|
offerIds - [ID!]!
|
|
percentGreenGoal - Int
|
Example
{
"consumerIds": ["abc123"],
"endDate": "2022-12-31",
"offerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"percentGreenGoal": 42
}
CertificateClaimDTO
Fields
| Field Name | Description |
|---|---|
amountInWh - String!
|
|
certificate - CertificateDTO!
|
Example
{"amountInWh": "1000", "certificate": CertificateDTO}
CertificateClaimRq
CertificateDTO
Description
Certificate information. Includes:
- Status and volume details
- Generation period and source
- Blockchain identifiers (when minted)
- Related organizations and RECs
- Claim events
Fields
| Field Name | Description |
|---|---|
claimSingleEventResponses - [ClaimSingleEventResponse!]
|
|
energyAmountInWh - String!
|
|
externalId - String
|
|
generationEnd - String!
|
|
generationStart - String!
|
|
generator - GeneratorDTO!
|
|
id - ID!
|
|
isGreenECertified - Boolean
|
|
label - String
|
|
openVolumeInWh - String!
|
|
productType - ProductType!
|
|
providerReferenceNumber - String
|
|
recSource - RecSourceDTO
|
|
recSourceDistributions - [CertificateRecSourceDistributionDTO!]
|
|
redemption - RedemptionDTO!
|
|
status - CertificateStatus!
|
|
supplier - OrganizationDTO
|
|
tenant - OrganizationDTO
|
|
w3Id - String
|
|
w3MintBlock - Int
|
Example
{
"claimSingleEventResponses": [ClaimSingleEventResponse],
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"isGreenECertified": true,
"label": "SOME_LABEL",
"openVolumeInWh": "1000",
"productType": "EUGO",
"providerReferenceNumber": "abc123",
"recSource": RecSourceDTO,
"recSourceDistributions": [
CertificateRecSourceDistributionDTO
],
"redemption": RedemptionDTO,
"status": "CREATED",
"supplier": OrganizationDTO,
"tenant": OrganizationDTO,
"w3Id": "abc123",
"w3MintBlock": 42
}
CertificateFiltersRq
Fields
| Input Field | Description |
|---|---|
consumer - ConsumerFiltersRq
|
|
externalId - String
|
|
generationEnd - String
|
|
generationStart - String
|
|
generator - GeneratorFiltersRq
|
|
id - ID
|
|
inventoryId - String
|
|
label - String
|
|
productType - ProductType
|
|
recSource - RecSourceFiltersRq
|
|
redemptionId - ID
|
|
status - [CertificateStatus!]
|
|
supplierName - StringFilter
|
|
tenantId - ID
|
Example
{
"consumer": ConsumerFiltersRq,
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generator": GeneratorFiltersRq,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventoryId": "1_1",
"label": "SOME_LABEL",
"productType": "EUGO",
"recSource": RecSourceFiltersRq,
"redemptionId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"status": ["CREATED"],
"supplierName": "Some Name",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
CertificateListRq
Fields
| Input Field | Description |
|---|---|
filters - CertificateFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": CertificateFiltersRq,
"pagination": PaginationRq
}
CertificateListRs
Fields
| Field Name | Description |
|---|---|
data - [CertificateDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [CertificateDTO],
"pagination": PaginationRs
}
CertificateRecSourceDistributionDTO
CertificateStatus
Description
Certificate blockchain status. States:
- DRAFT: Not yet initialized, waiting for verification
- CREATED: Certificate initialized in system
- MINT_REQUESTED: Mint operation requested
- MINTING: Currently being minted on blockchain
- MINTED: Successfully minted on blockchain
- USED: Fully claimed or retired
- ERROR: Error occurred during minting
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
ChangePasswordRq
ClaimCertificatesRq
Description
Request to claim certificates for a consumption. Restrictions:
- Certificate must be in MINTED status if blockchain enabled (CREATED if disabled)
- Each certificate must have sufficient open volume
- Total claimed amount cannot exceed certificate's available volume
- Claims cannot be modified once made
Example
{
"certificateClaims": [CertificateClaimRq],
"deliveryPartnerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"measuringPartnerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"metadata": "xyz789",
"submissionToken": "1699281292576:9a0b3ff48b"
}
ClaimSingleEventResponse
Description
Blockchain claim event information. Contains:
- Certificate and transaction details
- Claim data and signatures
- Blockchain identifiers
Example
{
"blockNumber": 42,
"certificateId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"claimData": "abc123",
"claimIssuer": "abc123",
"claimSubject": "xyz789",
"claimedValue": "abc123",
"topic": 42,
"txHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"web3Id": "xyz789"
}
ConfirmPasswordRq
ConnectUtilityAccountRq
ConsumerDTO
Description
Consumer information including metadata, location, and consumption estimates. Includes:
- Basic information (name, description, type)
- Location details
- Consumption estimates
- Emissions data
- Partner organizations
Fields
| Field Name | Description |
|---|---|
address - String
|
|
data - [ConsumerFieldDTO!]
|
|
deliveryPartners - [OrganizationDTO!]
|
|
description - String
|
|
documents - [FileDTO!]
|
|
emissionsFactor - ConsumerEmissionsFactorDTO
|
|
estimatedDailyConsumptionInWh - String
|
|
estimatedMonthlyConsumptions - [EstimatedMonthlyConsumptionDTO!]!
|
|
externalId - String
|
|
id - ID!
|
|
images - [FileDTO!]
|
|
latitude - String
|
|
location - LocationDTO!
|
|
longitude - String
|
|
measuringPartners - [OrganizationDTO!]
|
|
metadata - ConsumerMetadataDTO!
|
|
name - String
|
|
organization - OrganizationDTO!
|
|
percentGreenGoal - Int!
|
|
priorityListIds - [ID]!
|
|
productType - ProductType
|
|
tags - [String!]
|
|
tenant - OrganizationDTO
|
Example
{
"address": "Some Address 123",
"data": [ConsumerFieldDTO],
"deliveryPartners": [OrganizationDTO],
"description": "This is a description",
"documents": [FileDTO],
"emissionsFactor": ConsumerEmissionsFactorDTO,
"estimatedDailyConsumptionInWh": "abc123",
"estimatedMonthlyConsumptions": [
EstimatedMonthlyConsumptionDTO
],
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"latitude": "xyz789",
"location": LocationDTO,
"longitude": "xyz789",
"measuringPartners": [OrganizationDTO],
"metadata": ConsumerMetadataDTO,
"name": "Some Name",
"organization": OrganizationDTO,
"percentGreenGoal": 42,
"priorityListIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"productType": "EUGO",
"tags": ["abc123"],
"tenant": OrganizationDTO
}
ConsumerEmissionsFactorDTO
Fields
| Field Name | Description |
|---|---|
unit - ConsumerEmissionsFactorUnit!
|
|
value - Float!
|
Example
{"unit": "g_per_MWh", "value": 987.65}
ConsumerEmissionsFactorRq
Fields
| Input Field | Description |
|---|---|
unit - ConsumerEmissionsFactorUnit!
|
|
value - Float!
|
Example
{"unit": "g_per_MWh", "value": 987.65}
ConsumerEmissionsFactorUnit
Description
Units for emissions factors. Supports various mass and energy unit combinations:
- Grams per Wh/kWh/MWh
- Kilograms per Wh/kWh/MWh
- Tonnes per MWh/GJ
- Pounds per Wh/kWh/MWh
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"g_per_MWh"
ConsumerEstimatedCleanDTO
ConsumerFieldDTO
Description
Consumer field definition with type and value information. Contains:
- Order number (lower numbers shown first)
- Field type (text, number, boolean, json)
- Name and description
- Required flag
- Field value
Example
{
"consumerFieldType": "BOOLEAN",
"description": "This is a description",
"name": "Some Name",
"orderNumber": 42,
"required": false,
"value": "xyz789"
}
ConsumerFieldFilterRq
Fields
| Input Field | Description |
|---|---|
orderNumber - Int!
|
|
values - [MixedType!]
|
Example
{"orderNumber": 42, "values": [MixedType]}
ConsumerFieldType
Description
Types of consumer field values. Types:
- TEXT: String values
- NUMBER: Numeric values
- BOOLEAN: True/false values
- JSON: Structured data values
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOLEAN"
ConsumerFiltersRq
Fields
| Input Field | Description |
|---|---|
anyOrganizationId - ID
|
|
cleanPercentage - PercentageRangeFilterRq
|
|
country - String
|
|
data - [ConsumerFieldFilterRq!]
|
|
ids - [ID!]
|
|
metadata - ConsumerMetadataFiltersRq
|
|
name - StringFilter
|
|
organization - OrganizationFiltersRq
|
|
priorityListId - ID
|
|
tags - [String!]
|
Example
{
"anyOrganizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"cleanPercentage": PercentageRangeFilterRq,
"country": "US",
"data": [ConsumerFieldFilterRq],
"ids": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"metadata": ConsumerMetadataFiltersRq,
"name": "Some Name",
"organization": OrganizationFiltersRq,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tags": ["xyz789"]
}
ConsumerListConsumptionDataRs
Fields
| Field Name | Description |
|---|---|
data - [ConsumerMonthlyConsumptionDataDTO!]!
|
Example
{"data": [ConsumerMonthlyConsumptionDataDTO]}
ConsumerListRq
Fields
| Input Field | Description |
|---|---|
filters - ConsumerFiltersRq
|
|
pagination - PaginationRq
|
|
sort - ConsumerSortRq
|
Example
{
"filters": ConsumerFiltersRq,
"pagination": PaginationRq,
"sort": ConsumerSortRq
}
ConsumerListRs
Fields
| Field Name | Description |
|---|---|
data - [ConsumerDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [ConsumerDTO],
"pagination": PaginationRs
}
ConsumerMetadataDTO
Description
Consumer metadata template information. Contains:
- Template details and type
- Visual assets
- Field definitions
Fields
| Field Name | Description |
|---|---|
data - [ConsumerMetadataFieldDTO!]
|
|
description - String
|
|
entityType - String!
|
|
id - ID!
|
|
images - [FileDTO!]
|
|
name - String!
|
|
tenantId - ID
|
Example
{
"data": [ConsumerMetadataFieldDTO],
"description": "This is a description",
"entityType": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"name": "Some Name",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
ConsumerMetadataFieldDTO
Description
Consumer metadata field information. Contains:
- Order and type details
- Field name and description
- Required status
Fields
| Field Name | Description |
|---|---|
consumerFieldType - ConsumerFieldType!
|
|
description - String
|
|
name - String!
|
|
orderNumber - Int!
|
|
required - Boolean!
|
Example
{
"consumerFieldType": "BOOLEAN",
"description": "This is a description",
"name": "Some Name",
"orderNumber": 42,
"required": true
}
ConsumerMetadataFiltersRq
Description
Filter criteria for consumer metadata. Filter by:
- Template details
- Type and tenant
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
linkedToConsumer - Boolean
|
|
name - StringFilter
|
|
tenantId - ID
|
|
type - String
|
Example
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"linkedToConsumer": true,
"name": "Some Name",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"type": "abc123"
}
ConsumerMetadataListRq
Fields
| Input Field | Description |
|---|---|
filters - ConsumerMetadataFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": ConsumerMetadataFiltersRq,
"pagination": PaginationRq
}
ConsumerMetadataListRs
Fields
| Field Name | Description |
|---|---|
data - [ConsumerMetadataDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [ConsumerMetadataDTO],
"pagination": PaginationRs
}
ConsumerMonthlyConsumptionDataDTO
ConsumerSortField
Description
Available consumer sorting fields. Fields:
- emissionsFactor_g_per_wh: Sort by emissions factor
- name: Sort by consumer name
- cleanEnergyAmountInWh: Sort by clean energy amount
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"cleanEnergyAmountInWh"
ConsumerSortRq
Fields
| Input Field | Description |
|---|---|
field - ConsumerSortField!
|
|
order - SortOrder
|
Example
{"field": "cleanEnergyAmountInWh", "order": "ASC"}
ConsumerSummaryDTO
Description
Consumer count summary.
Fields
| Field Name | Description |
|---|---|
numberOfConsumers - Int
|
Example
{"numberOfConsumers": 42}
ConsumptionDTO
Fields
| Field Name | Description |
|---|---|
certificates - [CertificateClaimDTO!]!
|
|
consumer - ConsumerDTO!
|
|
decarbonizationStatus - DecarbonizationStatus!
|
|
deliveryPartners - [OrganizationDTO!]
|
|
deploymentStatus - AgreementDeploymentStatus
|
|
documents - [FileDTO!]!
|
|
endDate - String!
|
|
energyAmountInWh - String!
|
|
externalId - String
|
|
futureREC - Boolean!
|
|
id - ID!
|
|
label - String
|
|
measuringPartners - [OrganizationDTO!]
|
|
metadata - String
|
|
percentGreenGoal - Int!
|
|
reportingEndDate - String!
|
|
reportingStartDate - String!
|
|
startDate - String!
|
|
visibility - ConsumptionVisibility
|
|
w3Address - String
|
|
w3BuyerAddress - String
|
|
w3ClaimAgreementTxHashList - [String!]
|
|
w3DeployAgreementTxHash - String
|
|
w3FillAgreementTxHashList - [String!]
|
|
w3SellerAddress - String
|
|
w3SignAgreementTxHash - String
|
Example
{
"certificates": [CertificateClaimDTO],
"consumer": ConsumerDTO,
"decarbonizationStatus": "DECARBONIZED",
"deliveryPartners": [OrganizationDTO],
"deploymentStatus": "COMPLETED",
"documents": [FileDTO],
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"futureREC": false,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"measuringPartners": [OrganizationDTO],
"metadata": "abc123",
"percentGreenGoal": 42,
"reportingEndDate": "2022-12-31",
"reportingStartDate": "2022-01-01",
"startDate": "2022-01-01",
"visibility": "PRIVATE",
"w3Address": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3BuyerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3ClaimAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3DeployAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"w3FillAgreementTxHashList": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"w3SellerAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"w3SignAgreementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
}
ConsumptionFiltersRq
Description
Input for filtering consumptions
Fields
| Input Field | Description |
|---|---|
certificate - CertificateFiltersRq
|
|
consumer - ConsumerFiltersRq
|
|
decarbonizationStatus - EnumFilter
|
|
endDate - String
|
|
exclude - ConsumptionListExcludeRq
|
|
externalId - String
|
|
futureREC - Boolean
|
|
hasScope3Allocations - Boolean
|
|
id - ID
|
|
label - String
|
|
priorityListId - ID
|
|
reportingEndDate - String
|
|
reportingStartDate - String
|
|
scope3AllocationOrganizationId - ID
|
|
startDate - String
|
|
tenantId - ID
|
|
visibility - ConsumptionVisibility
|
Example
{
"certificate": CertificateFiltersRq,
"consumer": ConsumerFiltersRq,
"decarbonizationStatus": EnumFilter,
"endDate": "2022-12-31",
"exclude": ConsumptionListExcludeRq,
"externalId": "SOME_EXTERNAL_ID-1234",
"futureREC": false,
"hasScope3Allocations": false,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"reportingEndDate": "2022-12-31",
"reportingStartDate": "2022-01-01",
"scope3AllocationOrganizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"startDate": "2022-01-01",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"visibility": "PRIVATE"
}
ConsumptionListExcludeRq
Fields
| Input Field | Description |
|---|---|
organizationId - String
|
Example
{"organizationId": "abc123"}
ConsumptionListRq
Fields
| Input Field | Description |
|---|---|
filters - ConsumptionFiltersRq
|
|
pagination - PaginationRq
|
|
sort - ConsumptionSortRq
|
Example
{
"filters": ConsumptionFiltersRq,
"pagination": PaginationRq,
"sort": ConsumptionSortRq
}
ConsumptionListRs
Fields
| Field Name | Description |
|---|---|
data - [ConsumptionDTO!]!
|
|
pagination - PaginationRs
|
Example
{
"data": [ConsumptionDTO],
"pagination": PaginationRs
}
ConsumptionScope3AllocationDTO
Fields
| Field Name | Description |
|---|---|
cleanEnergyAmountInWh - String!
|
|
consumedEnergyAmountInWh - String!
|
|
consumption - ConsumptionDTO!
|
|
endDate - String!
|
|
id - ID!
|
|
scope3Allocation - Scope3AllocationDTO!
|
|
startDate - String!
|
Example
{
"cleanEnergyAmountInWh": "1000",
"consumedEnergyAmountInWh": "1000",
"consumption": ConsumptionDTO,
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"scope3Allocation": Scope3AllocationDTO,
"startDate": "2022-01-01"
}
ConsumptionScope3AllocationFiltersRq
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"consumption": ConsumptionFiltersRq,
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"scope3AllocationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"startDate": "2022-01-01"
}
ConsumptionScope3AllocationListRq
Fields
| Input Field | Description |
|---|---|
filters - ConsumptionScope3AllocationFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": ConsumptionScope3AllocationFiltersRq,
"pagination": PaginationRq
}
ConsumptionScope3AllocationListRs
Fields
| Field Name | Description |
|---|---|
data - [ConsumptionScope3AllocationDTO!]!
|
|
pagination - PaginationRs
|
Example
{
"data": [ConsumptionScope3AllocationDTO],
"pagination": PaginationRs
}
ConsumptionScope3AllocationSummaryDTO
Description
Consumption-specific Scope 3 allocation summary. Includes clean and consumed energy amounts.
Example
{
"numberOfAllocations": 42,
"totalCleanAmountInWh": "1000",
"totalConsumedAmountInWh": "1000"
}
ConsumptionSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
ConsumptionSortRq
Fields
| Input Field | Description |
|---|---|
field - ConsumptionSortField!
|
|
order - SortOrder
|
Example
{"field": "createdAt", "order": "ASC"}
ConsumptionSummaryDTO
Description
Consumption summary statistics. Contains:
- Total and average energy amounts
- Yearly breakdowns
- Consumption count
Fields
| Field Name | Description |
|---|---|
averageAmountInWh - String
|
|
numberOfConsumptions - Int
|
|
perYearSummary - [AmountPerYearSummary!]
|
|
totalAmountInWh - String
|
Example
{
"averageAmountInWh": "1000",
"numberOfConsumptions": 42,
"perYearSummary": [AmountPerYearSummary],
"totalAmountInWh": "1000"
}
ConsumptionVisibility
Description
Visibility status of a consumption. States:
- PRIVATE: Not deployed to blockchain
- PUBLIC: Deployed to blockchain (irreversible)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRIVATE"
CreateCertificateRecSourceDistributionRq
CreateCertificateRq
Fields
| Input Field | Description |
|---|---|
energyAmountInWh - String!
|
|
externalId - String
|
|
generationEnd - String!
|
|
generationStart - String!
|
|
generatorId - ID!
|
|
id - ID
|
|
isDraft - Boolean
|
|
isGreenECertified - Boolean
|
|
label - String
|
|
productType - ProductType
|
|
providerReferenceNumber - String
|
|
recSourceDistributions - [CreateCertificateRecSourceDistributionRq!]
|
|
recSourceId - ID
|
|
redemptionId - ID!
|
|
supplierId - ID
|
|
tenantId - ID
|
Example
{
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generatorId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"isDraft": true,
"isGreenECertified": true,
"label": "SOME_LABEL",
"productType": "EUGO",
"providerReferenceNumber": "xyz789",
"recSourceDistributions": [
CreateCertificateRecSourceDistributionRq
],
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"redemptionId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"supplierId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
CreateCertificatesRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateCertificateRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateCertificateRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateConsumerFieldRq
Fields
| Input Field | Description |
|---|---|
orderNumber - Int!
|
|
value - MixedType!
|
Example
{"orderNumber": 42, "value": MixedType}
CreateConsumerRq
Fields
| Input Field | Description |
|---|---|
address - String
|
|
data - [CreateConsumerFieldRq!]!
|
|
deliveryPartnerIds - [ID!]
|
|
description - String
|
|
documentIds - [ID!]
|
|
emissionsFactor - ConsumerEmissionsFactorRq
|
|
estimatedDailyConsumptionInWh - String
|
|
externalId - String
|
|
id - ID
|
|
imageIds - [ID!]
|
|
latitude - String
|
|
location - LocationRq!
|
|
longitude - String
|
|
measuringPartnerIds - [ID!]
|
|
metadataId - ID!
|
|
name - String
|
|
organizationId - ID!
|
|
percentGreenGoal - Int
|
|
productType - ProductType
|
|
tags - [String!]
|
Example
{
"address": "Some Address 123",
"data": [{"orderNumber": 1, "value": "Vacuum cleaner"}],
"deliveryPartnerIds": ["eef5d3e7-dc69-4fea-9825-78c97dfeb4eb"],
"description": "This is a description",
"documentIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"emissionsFactor": [{"value": 10, "unit": "g_per_Wh"}],
"estimatedDailyConsumptionInWh": 10000,
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "74b205b6-e4cf-46eb-99d8-9aeb922f83e7",
"imageIds": ["dd256bfb-6ec0-4052-a998-6d6513c8649b"],
"latitude": 49.6928237,
"location": {"country": "EE", "region": "EU"},
"longitude": 3.8474539,
"measuringPartnerIds": ["eef5d3e7-dc69-4fea-9825-78c97dfeb4eb"],
"metadataId": "050117d0-2800-11ed-a261-0242ac120002",
"name": "Some Name",
"organizationId": "c9fc4a6c-efa4-43c7-af35-cf361d3b67ae",
"percentGreenGoal": 42,
"productType": "EUGO",
"tags": ["tag1", "tag2"]
}
CreateConsumersRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateConsumerRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateConsumerRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateConsumptionRq
Description
Create a new consumption. Restrictions:
- Date range cannot overlap with other consumptions
- When public, blockchain must be enabled
Example
{
"consumerId": "4f1a8cf8-9d52-4b6c-8f0a-7a6d2f58ecdc",
"documentIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"futureREC": false,
"id": "2b3134fd-e786-4e4e-aa8e-1d71b4ceae5d",
"label": "SOME_LABEL",
"metadata": "abc123",
"percentGreenGoal": 100,
"startDate": "2022-01-01",
"visibility": "PRIVATE"
}
CreateConsumptionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateConsumptionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateConsumptionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateGeneratorRq
Fields
| Input Field | Description |
|---|---|
commissioningDate - String
|
|
country - String!
|
|
energySource - EnergyType!
|
|
externalId - String
|
|
id - ID
|
|
imageIds - [ID!]
|
|
impactStories - [String!]
|
|
latitude - String
|
|
links - [String!]
|
|
longitude - String
|
|
name - String!
|
|
nameplateCapacityInW - String
|
|
region - String
|
|
registryGeneratorId - String
|
|
state - String
|
|
support - String
|
Example
{
"commissioningDate": "2022-09-21",
"country": "US",
"energySource": "WIND",
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "f692954e-2416-412a-8ed6-638b91302058",
"imageIds": ["dd256bfb-6ec0-4052-a998-6d6513c8649b"],
"impactStories": ["story1", "story2"],
"latitude": 45.81444,
"links": ["image link"],
"longitude": 15.97798,
"name": "Some Name",
"nameplateCapacityInW": "Some Name",
"region": "North America",
"registryGeneratorId": "string",
"state": "CA",
"support": "support"
}
CreateGeneratorsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateGeneratorRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateGeneratorRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateMatchingPreferencesRq
Fields
| Input Field | Description |
|---|---|
consumptionLocationStrict - Boolean
|
|
consumptionTimeStrict - Boolean
|
|
energyTypes - [EnergyType!]
|
Example
{
"consumptionLocationStrict": true,
"consumptionTimeStrict": false,
"energyTypes": ["BIOGAS"]
}
CreateOrganizationRq
Fields
| Input Field | Description |
|---|---|
address - String
|
|
blockchainAddress - String
|
|
city - String
|
|
colorPrimary - String
|
|
colorSecondary - String
|
|
companyName - String
|
|
customerIds - [ID!]
|
|
description - String
|
|
email - String
|
|
externalId - String
|
|
goals - String
|
|
id - ID
|
|
imageIds - [ID!]
|
|
inventoryIds - [String!]
|
|
isRecProvider - Boolean
|
|
location - LocationRq
|
|
logoId - ID
|
|
mainCommercialContactEmail - String
|
|
mainCommercialContactName - String
|
|
mainTechnicalContactEmail - String
|
|
mainTechnicalContactName - String
|
|
name - String!
|
|
partnershipText - String
|
|
publicEmail - String
|
|
shortText - String
|
|
social - String
|
|
supplierIds - [ID!]
|
|
tags - [String!]
|
|
tenantId - ID
|
|
vat - String
|
|
website - String
|
|
zip - String
|
Example
{
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "xyz789",
"colorSecondary": "abc123",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "abc123",
"id": "00d0ea6d-aac7-4601-ad87-16cb8344fb72",
"imageIds": ["dd256bfb-6ec0-4052-a998-6d6513c8649b"],
"inventoryIds": ["1_1"],
"isRecProvider": false,
"location": LocationRq,
"logoId": "dd256bfb-6ec0-4052-a998-6d6513c8649b",
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"partnershipText": "xyz789",
"publicEmail": "some-email@example.org",
"shortText": "xyz789",
"social": "@SomeHandle",
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["tag1"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"vat": "abc123",
"website": "https://example.org",
"zip": "92704"
}
CreateOrganizationsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateOrganizationRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateOrganizationRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreatePriorityListItemRq
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"energyAmountInWh": "1000",
"id": "00d0ea6d-aac7-4601-ad87-16cb8344fb72",
"percentage": 42,
"priority": 42,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
CreatePriorityListItemsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreatePriorityListItemRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreatePriorityListItemRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreatePriorityListRq
Example
{
"description": "This is a description",
"id": "00d0ea6d-aac7-4601-ad87-16cb8344fb72",
"items": [CreatePriorityListItemRq],
"name": "Some Name",
"recSourceIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["tag1"]
}
CreatePriorityListsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreatePriorityListRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreatePriorityListRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateProofProposalCertificateAmountRq
CreateProofProposalRq
Fields
| Input Field | Description |
|---|---|
certificateAmounts - [CreateProofProposalCertificateAmountRq!]!
|
|
consumptionId - ID!
|
|
id - ID
|
|
priorityListItemId - ID
|
Example
{
"certificateAmounts": ["1000"],
"consumptionId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"priorityListItemId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
CreateProofProposalsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateProofProposalRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateProofProposalRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateProofRequestRq
Example
{
"cancelUrl": "abc123",
"consumptionIds": ["74b205b6-e4cf-46eb-99d8-9aeb922f83e7"],
"id": "ae653774-f89b-4681-8d4e-00bd8880ceec",
"offerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"preferences": CreateMatchingPreferencesRq,
"successUrl": "xyz789",
"tags": ["A"]
}
CreateProofRequestsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateProofRequestRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateProofRequestRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateRecSourceRq
Fields
| Input Field | Description |
|---|---|
currency - String
|
|
deliveryDate - String
|
|
deliveryType - DeliveryType!
|
|
endDate - String!
|
|
energyAmountInWh - String
|
|
energyAmountPercentage - Float
|
|
energySources - [EnergyType!]
|
|
externalId - String
|
|
generatorId - ID
|
|
id - ID
|
|
inventoryId - String!
|
|
label - String
|
|
locations - [LocationRq!]
|
|
orderDate - String
|
|
pricePerWh - Float
|
|
productType - ProductType
|
|
providerId - ID
|
|
recurringDeliveryPeriod - RecurringTimePeriod
|
|
recurringType - RecurringRecSourceType
|
|
startDate - String!
|
|
tenantId - ID
|
Example
{
"currency": "USD",
"deliveryDate": "2022-09-21",
"deliveryType": "RECURRING",
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"energyAmountPercentage": "1000",
"energySources": ["BIOGAS"],
"externalId": "SOME_EXTERNAL_ID-1234",
"generatorId": "f692954e-2416-412a-8ed6-638b91302058",
"id": "870f065e-b90e-415a-9918-12d548856a56",
"inventoryId": "1_1",
"label": "SOME_LABEL",
"locations": [{"country": "EE", "region": "EU"}],
"orderDate": "2022-09-21",
"pricePerWh": 0.000012,
"productType": "EUGO",
"providerId": "9f80f770-d05b-4fc8-b1b9-865ad9cd1fbf",
"recurringDeliveryPeriod": "MONTHLY",
"recurringType": "PPA",
"startDate": "2022-01-01",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
CreateRecSourcesRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateRecSourceRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateRecSourceRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateRedemptionRq
Example
{
"comment": "Some random comment",
"energyAmountInWh": "1000",
"id": "0x0d63730e6522d34fb200e2399a262ef96cbf46ee8da762383111d1bcd200c752",
"inventoryId": "1_1",
"name": "Some Name",
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"redemptionStatementId": "eed15f92-e43b-4430-bf27-b0c433d99329",
"registry": "WREGIS",
"tags": ["A"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
CreateRedemptionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateRedemptionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateRedemptionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateScope3AllocationRq
Example
{
"cleanEnergyAmountInWh": "1000",
"consumedEnergyAmountInWh": "1000",
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"startDate": "2022-01-01"
}
CreateScope3AllocationsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateScope3AllocationRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateScope3AllocationRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateSubscriptionRq
Fields
| Input Field | Description |
|---|---|
cancelUrl - String!
|
|
consumerIds - [String!]!
|
|
endDate - String!
|
|
id - ID
|
|
offerIds - [ID!]!
|
|
percentGreenGoal - Int
|
|
preferences - CreateMatchingPreferencesRq
|
|
successUrl - String!
|
Example
{
"cancelUrl": "abc123",
"consumerIds": ["abc123"],
"endDate": "2022-12-31",
"id": "1dbca0ce-0b10-46ab-85db-357baa658ba2",
"offerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"percentGreenGoal": 42,
"preferences": CreateMatchingPreferencesRq,
"successUrl": "xyz789"
}
CreateSubscriptionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateSubscriptionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateSubscriptionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateTenantPermissionRq
Fields
| Input Field | Description |
|---|---|
accessingTenantId - ID!
|
|
id - ID
|
|
ownerTenantId - ID
|
|
rights - [PermissionRight!]!
|
|
type - PermissionType!
|
Example
{
"accessingTenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"ownerTenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"rights": ["ALLOCATION"],
"type": "READ"
}
CreateTenantPermissionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [CreateTenantPermissionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [CreateTenantPermissionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
CreateTenantRq
Fields
| Input Field | Description |
|---|---|
address - String
|
|
blockchainAddress - String
|
|
city - String
|
|
colorPrimary - String
|
|
colorSecondary - String
|
|
companyName - String
|
|
customerIds - [ID!]
|
|
description - String
|
|
email - String
|
|
externalId - String
|
|
goals - String
|
|
id - ID
|
|
imageIds - [ID!]
|
|
inventoryIds - [String!]
|
|
isRecProvider - Boolean
|
|
location - LocationRq
|
|
logoId - ID
|
|
mainCommercialContactEmail - String
|
|
mainCommercialContactName - String
|
|
mainTechnicalContactEmail - String
|
|
mainTechnicalContactName - String
|
|
name - String!
|
|
partnershipText - String
|
|
publicEmail - String
|
|
settings - TenantSettingsRq
|
|
shortText - String
|
|
social - String
|
|
submissionToken - String!
|
|
supplierIds - [ID!]
|
|
tags - [String!]
|
|
vat - String
|
|
website - String
|
|
zip - String
|
Example
{
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "#009CDE",
"colorSecondary": "#95E8E6",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "goals",
"id": "9f80f770-d05b-4fc8-b1b9-865ad9cd1fbf",
"imageIds": ["dd256bfb-6ec0-4052-a998-6d6513c8649b"],
"inventoryIds": ["1_1"],
"isRecProvider": false,
"location": {"country": "EE", "region": "EU"},
"logoId": "dd256bfb-6ec0-4052-a998-6d6513c8649b",
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"partnershipText": "partnership text",
"publicEmail": "some-email@example.org",
"settings": {"onboardingMode": "SIMPLE"},
"shortText": "short text",
"social": "@SomeHandle",
"submissionToken": "1699281292576:9a0b3ff48b",
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["tag1"],
"vat": 0,
"website": "https://example.org",
"zip": "92704"
}
DecarbonizationStatus
Description
Current state of a consumption's decarbonization process. States:
- NOT_DECARBONIZED: No certificates claimed or promised
- PARTIAL_DECARBONIZATION_PROMISED: Some certificates allocated but not claimed
- FULL_DECARBONIZATION_PROMISED: All required certificates allocated but not claimed
- PARTIALLY_DECARBONIZED: Some certificates claimed but full volume not covered
- DECARBONIZED: Full consumption volume covered by certificates
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DECARBONIZED"
DeliveryType
Description
Type of REC source delivery. Types:
- ONE_TIME: Single delivery on specific date
- RECURRING: Regular deliveries over a period
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ONE_TIME"
DisconnectUtilityAccountRq
EnergyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BIOGAS"
EnumFilter
Fields
| Input Field | Description |
|---|---|
type - EnumFilterType
|
|
value - String!
|
Example
{"type": "equals", "value": "xyz789"}
EnumFilterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"equals"
EstimatedMonthlyConsumptionDTO
FeatureLimitUsageDTO
FileDTO
Description
File information including storage locations.
- Files are initially uploaded to storage
- Important files are archived to IPFS and Arweave
Example
{
"arweaveTransactionId": "abc123",
"fileType": "ConsumerImage",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"ipfsCid": "xyz789",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"url": "abc123"
}
FileFiltersRq
Example
{
"consumerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"consumptionIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"fileType": "ConsumerImage",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
FileListRq
Fields
| Input Field | Description |
|---|---|
filters - FileFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": FileFiltersRq,
"pagination": PaginationRq
}
FileListRs
Fields
| Field Name | Description |
|---|---|
data - [FileDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [FileDTO],
"pagination": PaginationRs
}
FileType
Description
Supported file types in the system. Types:
- RedemptionStatement: Redemption statement documents
- OrganizationImage: Organization profile images
- OrganizationLogo: Organization logo images
- ConsumerImage: Consumer profile images
- ConsumerMetadataImage: Consumer metadata images
- GeneratorImage: Generator facility images
- OfferImage: Offer display images
- ConsumptionDocument: Supporting documents for consumptions
- Csv: Data import files
- ElectricityBill: Electricity bill documents
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ConsumerImage"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GenerateProofProposalsRq
GeneratorDTO
Description
Generator facility information. Contains:
- Basic details (name, energy source)
- Location and coordinates
- Technical specifications
- Supporting content (stories, images)
Fields
| Field Name | Description |
|---|---|
commissioningDate - String
|
|
energySource - EnergyType!
|
|
externalId - String
|
|
id - ID!
|
|
images - [FileDTO!]
|
|
impactStories - [String!]
|
|
latitude - String
|
|
links - [String!]
|
|
location - LocationDTO!
|
|
longitude - String
|
|
name - String!
|
|
nameplateCapacityInW - String
|
|
registryGeneratorId - String
|
|
support - String
|
|
tenant - OrganizationDTO
|
Example
{
"commissioningDate": "2022-09-21",
"energySource": "BIOGAS",
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"impactStories": ["abc123"],
"latitude": "xyz789",
"links": ["xyz789"],
"location": LocationDTO,
"longitude": "xyz789",
"name": "Some Name",
"nameplateCapacityInW": "Some Name",
"registryGeneratorId": "abc123",
"support": "xyz789",
"tenant": OrganizationDTO
}
GeneratorFiltersRq
Fields
| Input Field | Description |
|---|---|
country - String
|
|
energySource - EnergyType
|
|
id - ID
|
|
name - StringFilter
|
Example
{
"country": "US",
"energySource": "BIOGAS",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"name": "Some Name"
}
GeneratorListRq
Description
Request to list generators. Supports filtering by:
- Name and ID
- Country location
- Energy source type
Fields
| Input Field | Description |
|---|---|
filters - GeneratorFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": GeneratorFiltersRq,
"pagination": PaginationRq
}
GeneratorListRs
Fields
| Field Name | Description |
|---|---|
data - [GeneratorDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [GeneratorDTO],
"pagination": PaginationRs
}
HandoverOrganizationDTO
Fields
| Field Name | Description |
|---|---|
token - String!
|
Example
{"token": "xyz789"}
HandoverOrganizationRq
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
IdRequired
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Possible Types
| IdRequired Types |
|---|
Example
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
42
InviteAuditorRq
InviteOrganizationAdminRq
JSON
Example
{}
LocationDTO
LocationRq
LoginRq
LoginRs
Fields
| Field Name | Description |
|---|---|
accessToken - AccessTokenRs!
|
|
idToken - String!
|
|
refreshToken - String!
|
Example
{
"accessToken": AccessTokenRs,
"idToken": "abc123",
"refreshToken": "xyz789"
}
LoginSsoCallbackRq
MatchingOfferRequestRq
Fields
| Input Field | Description |
|---|---|
amountInWh - String
|
|
productType - ProductType!
|
Example
{"amountInWh": "1000", "productType": "EUGO"}
MatchingPreferencesDTO
Fields
| Field Name | Description |
|---|---|
consumptionLocationStrict - Boolean
|
|
consumptionTimeStrict - Boolean
|
|
energyTypes - [EnergyType!]
|
Example
{
"consumptionLocationStrict": true,
"consumptionTimeStrict": false,
"energyTypes": ["BIOGAS"]
}
MixedType
Example
MixedType
OfferDTO
Description
Offer information:
- pricePerWh is in cents (e.g., EUR cents or USD cents)
Example
{
"availableCertificateEnergyAmountInWh": "1000",
"availableOrderEnergyAmountInWh": "1000",
"currency": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"image": FileDTO,
"pricePerWh": 123.45,
"productType": "EUGO",
"tags": ["abc123"]
}
OfferListRq
Fields
| Input Field | Description |
|---|---|
amountInWh - String
|
|
id - ID
|
|
pagination - PaginationRq
|
|
productType - ProductType
|
|
tags - [String!]
|
Example
{
"amountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"pagination": PaginationRq,
"productType": "EUGO",
"tags": ["abc123"]
}
OfferListRs
Fields
| Field Name | Description |
|---|---|
data - [OfferDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [OfferDTO],
"pagination": PaginationRs
}
OnboardingMode
Description
Organization onboarding mode. Modes:
- SIMPLE: Basic onboarding process
- ADVANCED: Full onboarding with all options
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADVANCED"
OrganizationDTO
Fields
| Field Name | Description |
|---|---|
address - String
|
|
blockchainAddress - String
|
|
city - String
|
|
colorPrimary - String
|
|
colorSecondary - String
|
|
companyName - String
|
|
customerIds - [ID!]
|
|
description - String
|
|
email - String
|
|
externalId - String
|
|
goals - String
|
|
id - ID!
|
|
images - [FileDTO!]
|
|
inventoryIds - [String!]!
|
|
isOrganizationAdminRegistered - Boolean!
|
|
isRecProvider - Boolean!
|
|
location - LocationDTO
|
|
logo - FileDTO
|
|
mainCommercialContactEmail - String
|
|
mainCommercialContactName - String
|
|
mainTechnicalContactEmail - String
|
|
mainTechnicalContactName - String
|
|
name - String!
|
|
onboardingPartnerId - ID
|
|
partnershipText - String
|
|
publicEmail - String
|
|
settings - TenantSettingsDTO!
|
|
shortText - String
|
|
social - String
|
|
summary - OrganizationSummariesDTO!
|
|
supplierIds - [ID!]
|
|
tags - [String!]
|
|
tenantId - ID!
|
|
vat - String
|
|
website - String
|
|
zip - String
|
Example
{
"address": "Some Address 123",
"blockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"city": "San Francisco",
"colorPrimary": "xyz789",
"colorSecondary": "abc123",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "xyz789",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"images": [FileDTO],
"inventoryIds": ["1_1"],
"isOrganizationAdminRegistered": false,
"isRecProvider": false,
"location": LocationDTO,
"logo": FileDTO,
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"onboardingPartnerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"partnershipText": "abc123",
"publicEmail": "some-email@example.org",
"settings": TenantSettingsDTO,
"shortText": "xyz789",
"social": "@SomeHandle",
"summary": OrganizationSummariesDTO,
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["xyz789"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"vat": "xyz789",
"website": "https://example.org",
"zip": "92704"
}
OrganizationFiltersRq
Fields
| Input Field | Description |
|---|---|
consumer - ConsumerFiltersRq
|
|
country - String
|
|
customerIds - [ID!]
|
|
email - StringFilter
|
|
exclude - OrganizationListExcludeRq
|
|
externalId - String
|
|
id - ID
|
|
includeScope3Relations - Boolean
|
|
isRecProvider - Boolean
|
|
name - StringFilter
|
|
supplierIds - [ID!]
|
|
tags - [String!]
|
|
tenantId - ID
|
Example
{
"consumer": ConsumerFiltersRq,
"country": "US",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"email": "some-email@example.org",
"exclude": OrganizationListExcludeRq,
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"includeScope3Relations": true,
"isRecProvider": false,
"name": "Some Name",
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["abc123"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
OrganizationListExcludeRq
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
OrganizationListRq
Fields
| Input Field | Description |
|---|---|
filters - OrganizationFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": OrganizationFiltersRq,
"pagination": PaginationRq
}
OrganizationListRs
Fields
| Field Name | Description |
|---|---|
data - [OrganizationDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [OrganizationDTO],
"pagination": PaginationRs
}
OrganizationSummariesDTO
Fields
| Field Name | Description |
|---|---|
consumers - ConsumerSummaryDTO!
|
|
numberOfCertificates - Int!
|
|
numberOfProofRequests - Int!
|
|
numberOfRedemptions - Int!
|
|
proofs - ProofSummaryDTO!
|
Example
{
"consumers": ConsumerSummaryDTO,
"numberOfCertificates": 42,
"numberOfProofRequests": 42,
"numberOfRedemptions": 42,
"proofs": ProofSummaryDTO
}
OrganizationSummaryDTO
Description
Organization count summary.
Fields
| Field Name | Description |
|---|---|
numberOfOrganizations - Int
|
Example
{"numberOfOrganizations": 42}
Pagination
Fields
| Field Name | Description |
|---|---|
pagination - PaginationRs
|
Possible Types
| Pagination Types |
|---|
Example
{"pagination": PaginationRs}
PaginationRq
PaginationRs
PaymentStatus
Description
Payment status of the proof request. Updated through Stripe checkout session events. States:
- PENDING_PAYMENT: Initial state after creation
- Stripe checkout session created
- Waiting for payment completion
- PAID: Payment successfully completed
- Enables proof generation if status is FULFILLABLE
- Marks consumptions as future REC
- EXPIRED: Payment window closed without completion
- Stripe session expired
- CANCELLED: Request manually cancelled
- Prevents further processing
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
PercentageRangeFilterRq
PermissionRight
Description
Available permission rights for different resource types. Rights:
- ALLOCATION: Scope3 allocation access (requires CONSUMER)
- CERTIFICATE: Certificate management
- CONSUMER: Consumer management
- CONSUMPTION: Consumption data access
- ORGANIZATION: Organization details
- PROOF: Proof management (requires CERTIFICATE)
- PROOF_REQUEST: Proof request handling
- REC_SOURCE: REC source management
- REDEMPTION: Redemption handling (requires CERTIFICATE)
- SUBSCRIPTION: Subscription management
Notes:
- WRITE permissions include corresponding READ access
- Some rights require other rights to be granted
- Rights affect specific operations
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALLOCATION"
PermissionType
Description
Permission type that determines access level. Types:
- READ: View access only
- WRITE: Full modification access (includes READ)
Note: WRITE always requires corresponding READ permission
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"READ"
PriorityListDTO
Fields
| Field Name | Description |
|---|---|
description - String
|
|
id - ID!
|
|
items - [PriorityListItemDTO]!
|
|
name - String
|
|
recSources - [RecSourceDTO!]!
|
|
tags - [String!]
|
Example
{
"description": "This is a description",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"items": [PriorityListItemDTO],
"name": "Some Name",
"recSources": [RecSourceDTO],
"tags": ["xyz789"]
}
PriorityListItemDTO
Example
{
"consumer": ConsumerDTO,
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"percentage": 42,
"priority": 42,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tags": ["xyz789"]
}
PriorityListItemRq
Fields
| Input Field | Description |
|---|---|
consumerId - ID
|
|
id - ID
|
|
pagination - PaginationRq
|
|
priorityListId - ID
|
|
sort - PriorityListItemSortRq
|
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"pagination": PaginationRq,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"sort": PriorityListItemSortRq
}
PriorityListItemSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"percentage"
PriorityListItemSortRq
Fields
| Input Field | Description |
|---|---|
field - PriorityListItemSortField!
|
|
order - SortOrder
|
Example
{"field": "percentage", "order": "ASC"}
PriorityListItemsRs
Fields
| Field Name | Description |
|---|---|
data - [PriorityListItemDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [PriorityListItemDTO],
"pagination": PaginationRs
}
PriorityListRq
Description
Filter criteria for priority lists. Filter by:
- List details
- Associated sources
- Consumers
- Tenant context
Fields
| Input Field | Description |
|---|---|
consumerId - ID
|
|
id - ID
|
|
name - StringFilter
|
|
pagination - PaginationRq
|
|
recSourceId - ID
|
|
tags - [String!]
|
|
tenantId - ID
|
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"name": "Some Name",
"pagination": PaginationRq,
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"tags": ["abc123"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
PriorityListsRs
Fields
| Field Name | Description |
|---|---|
data - [PriorityListDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [PriorityListDTO],
"pagination": PaginationRs
}
ProductType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EUGO"
ProofDTO
Fields
| Field Name | Description |
|---|---|
attestationUrl - String!
|
|
certificates - [CertificateClaimDTO!]!
|
|
consumption - ConsumptionDTO!
|
|
creationDate - String!
|
|
deliveryPartners - [OrganizationDTO!]
|
|
energyAmountInWh - String!
|
|
energyTypes - [EnergyType!]
|
|
generators - [GeneratorDTO!]!
|
|
id - ID!
|
|
measuringPartners - [OrganizationDTO!]
|
|
metadata - String
|
|
productTypes - [ProductType!]
|
|
suppliers - [OrganizationDTO!]
|
|
tenant - OrganizationDTO
|
Example
{
"attestationUrl": "xyz789",
"certificates": [CertificateClaimDTO],
"consumption": ConsumptionDTO,
"creationDate": "2022-09-21",
"deliveryPartners": [OrganizationDTO],
"energyAmountInWh": "1000",
"energyTypes": ["BIOGAS"],
"generators": [GeneratorDTO],
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"measuringPartners": [OrganizationDTO],
"metadata": "xyz789",
"productTypes": ["EUGO"],
"suppliers": [OrganizationDTO],
"tenant": OrganizationDTO
}
ProofEnergyTypeSummary
Description
Energy type breakdown for proofs. Includes total amount, count, and energy sources used.
Fields
| Field Name | Description |
|---|---|
energySources - [EnergyType!]!
|
|
numberOfProofs - Int!
|
|
totalAmountInWh - String!
|
Example
{"energySources": ["BIOGAS"], "numberOfProofs": 42, "totalAmountInWh": "1000"}
ProofFiltersRq
Fields
| Input Field | Description |
|---|---|
anyOrganizationId - ID
|
|
certificate - CertificateFiltersRq
|
|
consumer - ConsumerFiltersRq
|
|
consumptionEnd - String
|
|
consumptionStart - String
|
|
exclude - ProofListExcludeRq
|
|
hasScope3Allocations - Boolean
|
|
id - ID
|
|
organizationId - ID
|
|
organizationName - StringFilter
|
|
priorityListId - ID
|
|
reportingEnd - String
|
|
reportingStart - String
|
|
scope3AllocationOrganizationId - ID
|
|
sort - ProofSortRq
|
|
tenantName - StringFilter
|
Example
{
"anyOrganizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"certificate": CertificateFiltersRq,
"consumer": ConsumerFiltersRq,
"consumptionEnd": "2022-12-31",
"consumptionStart": "2022-01-01",
"exclude": ProofListExcludeRq,
"hasScope3Allocations": true,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organizationName": "Some Name",
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"reportingEnd": "2022-12-31",
"reportingStart": "2022-01-01",
"scope3AllocationOrganizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"sort": ProofSortRq,
"tenantName": "Some Name"
}
ProofListExcludeRq
Fields
| Input Field | Description |
|---|---|
organizationId - String
|
Example
{"organizationId": "abc123"}
ProofListRq
Fields
| Input Field | Description |
|---|---|
filters - ProofFiltersRq
|
|
pagination - PaginationRq
|
|
sort - ProofSortRq
|
Example
{
"filters": ProofFiltersRq,
"pagination": PaginationRq,
"sort": ProofSortRq
}
ProofListRs
Fields
| Field Name | Description |
|---|---|
data - [ProofDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [ProofDTO],
"pagination": PaginationRs
}
ProofProposalCertificateAmountDTO
Fields
| Field Name | Description |
|---|---|
certificate - CertificateDTO!
|
|
energyAmountInWh - String!
|
Example
{
"certificate": CertificateDTO,
"energyAmountInWh": "1000"
}
ProofProposalDTO
Fields
| Field Name | Description |
|---|---|
certificateAmounts - [ProofProposalCertificateAmountDTO!]!
|
|
consumption - ConsumptionDTO!
|
|
id - ID!
|
|
priorityListItem - PriorityListItemDTO
|
|
proof - ProofDTO
|
|
status - ProofProposalStatus!
|
Example
{
"certificateAmounts": ["1000"],
"consumption": ConsumptionDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"priorityListItem": PriorityListItemDTO,
"proof": ProofDTO,
"status": "ACCEPTED"
}
ProofProposalFiltersRq
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"priorityListItemId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"status": "ACCEPTED",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
ProofProposalListRq
Fields
| Input Field | Description |
|---|---|
filters - ProofProposalFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": ProofProposalFiltersRq,
"pagination": PaginationRq
}
ProofProposalListRs
Fields
| Field Name | Description |
|---|---|
data - [ProofProposalDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [ProofProposalDTO],
"pagination": PaginationRs
}
ProofProposalStatus
Description
Proof proposal status. States:
- PENDING: Awaiting accept/reject decision
- ACCEPTED: Approved and certificates claimed
- REJECTED: Declined by responder
- UNFULFILLABLE: Cannot be fulfilled (e.g., insufficient volume)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
ProofProposalSummaryDTO
ProofRequestDTO
Description
Proof request information. Contains:
- Fulfillment and payment status
- Consumption details
- Matching preferences
- Checkout information
Fields
| Field Name | Description |
|---|---|
checkoutSessionUrl - String!
|
|
consumptions - [ConsumptionDTO!]!
|
|
id - ID!
|
|
offer - OfferDTO
|
|
paymentStatus - PaymentStatus!
|
|
preferences - MatchingPreferencesDTO!
|
|
status - ProofRequestStatus!
|
|
tags - [String!]
|
Example
{
"checkoutSessionUrl": "abc123",
"consumptions": [ConsumptionDTO],
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"offer": OfferDTO,
"paymentStatus": "CANCELLED",
"preferences": MatchingPreferencesDTO,
"status": "FULFILLABLE",
"tags": ["abc123"]
}
ProofRequestFiltersRq
Fields
| Input Field | Description |
|---|---|
anyOrganizationId - ID
|
|
consumer - ConsumerFiltersRq
|
|
id - ID
|
|
paymentStatus - PaymentStatus
|
|
status - ProofRequestStatus
|
Example
{
"anyOrganizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"consumer": ConsumerFiltersRq,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"paymentStatus": "CANCELLED",
"status": "FULFILLABLE"
}
ProofRequestListRq
Fields
| Input Field | Description |
|---|---|
filters - ProofRequestFiltersRq
|
|
pagination - PaginationRq
|
|
sort - ProofRequestSortRq
|
Example
{
"filters": ProofRequestFiltersRq,
"pagination": PaginationRq,
"sort": ProofRequestSortRq
}
ProofRequestListRs
Fields
| Field Name | Description |
|---|---|
data - [ProofRequestDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [ProofRequestDTO],
"pagination": PaginationRs
}
ProofRequestSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"paymentStatus"
ProofRequestSortRq
Fields
| Input Field | Description |
|---|---|
field - ProofRequestSortField!
|
|
order - SortOrder
|
Example
{"field": "paymentStatus", "order": "ASC"}
ProofRequestStatus
Description
Proof request fulfillment status States:
- FULFILLABLE:
- Set when a matching offer exists
- Required for proof generation after payment
- UNFULFILLABLE:
- Set when no matching offer exists
- Prevents proof generation even after payment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FULFILLABLE"
ProofSortRq
Fields
| Input Field | Description |
|---|---|
field - ConsumptionSortField!
|
|
order - SortOrder
|
Example
{"field": "createdAt", "order": "ASC"}
ProofSummaryDTO
Description
Proof attestation summary statistics. Contains:
- Total and average energy amounts
- Energy source breakdowns
- Yearly statistics
- Proof count
Fields
| Field Name | Description |
|---|---|
averageAmountInWh - String
|
|
energySourcesSummary - [ProofEnergyTypeSummary!]
|
|
numberOfProofs - Int
|
|
perYearSummary - [AmountPerYearSummary!]
|
|
totalAmountInWh - String
|
Example
{
"averageAmountInWh": "1000",
"energySourcesSummary": [ProofEnergyTypeSummary],
"numberOfProofs": 42,
"perYearSummary": [AmountPerYearSummary],
"totalAmountInWh": "1000"
}
RecSourceCurrencySummary
Description
Financial summary for REC sources by currency. Includes:
- Price statistics (total and average)
- Cost statistics (total and average)
- Currency identifier
Example
{
"averageCost": "abc123",
"averagePrice": "xyz789",
"currency": "abc123",
"totalCost": "abc123",
"totalPrice": "xyz789"
}
RecSourceDTO
Fields
| Field Name | Description |
|---|---|
currency - String
|
|
deliveryDate - String
|
|
deliveryType - DeliveryType!
|
|
endDate - String!
|
|
energyAmountInWh - String
|
|
energyAmountPercentage - Float
|
|
energySources - [EnergyType!]
|
|
externalId - String
|
|
generator - GeneratorDTO
|
|
id - ID!
|
|
inventory - W3BlockchainPropertiesDTO!
|
|
label - String
|
|
locations - [LocationDTO!]
|
|
orderDate - String
|
|
pricePerWh - Float
|
|
priorityListId - ID
|
|
productType - ProductType
|
|
provider - OrganizationDTO
|
|
recurringDeliveryPeriod - RecurringTimePeriod
|
|
recurringType - RecurringRecSourceType
|
|
startDate - String!
|
|
tenant - OrganizationDTO
|
Example
{
"currency": "xyz789",
"deliveryDate": "2022-09-21",
"deliveryType": "ONE_TIME",
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"energyAmountPercentage": "1000",
"energySources": ["BIOGAS"],
"externalId": "SOME_EXTERNAL_ID-1234",
"generator": GeneratorDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventory": W3BlockchainPropertiesDTO,
"label": "SOME_LABEL",
"locations": [LocationDTO],
"orderDate": "2022-09-21",
"pricePerWh": 987.65,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"productType": "EUGO",
"provider": OrganizationDTO,
"recurringDeliveryPeriod": "DAILY",
"recurringType": "GreenTariff",
"startDate": "2022-01-01",
"tenant": OrganizationDTO
}
RecSourceFiltersRq
Fields
| Input Field | Description |
|---|---|
country - String
|
|
deliveryType - DeliveryType
|
|
endDate - String
|
|
energySources - [EnergyType]
|
|
externalId - String
|
|
generator - GeneratorFiltersRq
|
|
id - ID
|
|
inventoryId - String
|
|
label - String
|
|
priorityListConsumer - ConsumerFiltersRq
|
|
priorityListId - ID
|
|
productType - ProductType
|
|
providerId - ID
|
|
recurringType - RecurringRecSourceType
|
|
startDate - String
|
|
tenantId - ID
|
Example
{
"country": "US",
"deliveryType": "ONE_TIME",
"endDate": "2022-12-31",
"energySources": ["BIOGAS"],
"externalId": "SOME_EXTERNAL_ID-1234",
"generator": GeneratorFiltersRq,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventoryId": "1_1",
"label": "SOME_LABEL",
"priorityListConsumer": ConsumerFiltersRq,
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"productType": "EUGO",
"providerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"recurringType": "GreenTariff",
"startDate": "2022-01-01",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
RecSourceListRq
Fields
| Input Field | Description |
|---|---|
filters - RecSourceFiltersRq
|
|
pagination - PaginationRq
|
|
sort - RecSourceSortRq
|
Example
{
"filters": RecSourceFiltersRq,
"pagination": PaginationRq,
"sort": RecSourceSortRq
}
RecSourceListRs
Fields
| Field Name | Description |
|---|---|
data - [RecSourceDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [RecSourceDTO],
"pagination": PaginationRs
}
RecSourceSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
RecSourceSortRq
Fields
| Input Field | Description |
|---|---|
field - RecSourceSortField!
|
|
order - SortOrder
|
Example
{"field": "createdAt", "order": "ASC"}
RecSourceSummaryDTO
Description
REC source summary statistics. Contains:
- Energy amounts (total and average)
- Source count
- Financial summaries by currency
- Total generation capacity
Fields
| Field Name | Description |
|---|---|
averageAmountInWh - String!
|
|
currencySummary - [RecSourceCurrencySummary!]
|
|
numberOfRecSources - Int!
|
|
totalAmountInWh - String!
|
|
totalNameplateCapacityInW - String!
|
Example
{
"averageAmountInWh": "1000",
"currencySummary": [RecSourceCurrencySummary],
"numberOfRecSources": 42,
"totalAmountInWh": "1000",
"totalNameplateCapacityInW": "Some Name"
}
RecurringRecSourceType
Description
Type of recurring REC source. Types:
- Unbundled: Standard unbundled RECs
- GreenTariff: Utility green tariff program
- PPA: Power Purchase Agreement
- Onsite: On-site generation
- Subscription: REC subscription service
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GreenTariff"
RecurringTimePeriod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAILY"
RedemptionDTO
Fields
| Field Name | Description |
|---|---|
certificates - [CertificateDTO]
|
|
comment - String
|
|
description - String
|
|
energyAmountInWh - String
|
|
fullText - String!
|
|
id - ID!
|
|
inventory - W3BlockchainPropertiesDTO!
|
|
mintCertificatesTxHash - [String!]
|
|
name - String!
|
|
protocolVersion - String!
|
|
recSource - RecSourceDTO
|
|
redemptionStatement - FileDTO
|
|
redemptionStatementBcStatus - RedemptionStatementBcStatus!
|
|
redemptionStatementTxBlock - Int
|
|
redemptionStatementTxHash - String
|
|
registry - String
|
|
shortText - String
|
|
status - RedemptionStatus!
|
|
storagePointer - String
|
|
tags - [String!]
|
|
tenant - OrganizationDTO
|
|
title - String
|
|
trustLink - TrustLink!
|
Example
{
"certificates": [CertificateDTO],
"comment": "Some random comment",
"description": "This is a description",
"energyAmountInWh": "1000",
"fullText": "abc123",
"id": "0x0d63730e6522d34fb200e2399a262ef96cbf46ee8da762383111d1bcd200c752",
"inventory": W3BlockchainPropertiesDTO,
"mintCertificatesTxHash": [
"0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc"
],
"name": "Some Name",
"protocolVersion": "abc123",
"recSource": RecSourceDTO,
"redemptionStatement": FileDTO,
"redemptionStatementBcStatus": "REDEMPTION_STATEMENT_NOT_SET",
"redemptionStatementTxBlock": 42,
"redemptionStatementTxHash": "0x33fc7ccc89c1cafbbaf492268107cba9f49f86e7ade5e041e9c57f79f91342dc",
"registry": "abc123",
"shortText": "xyz789",
"status": "APPROVED",
"storagePointer": "abc123",
"tags": ["abc123"],
"tenant": OrganizationDTO,
"title": "This is a Title",
"trustLink": "ONE_DIRECTIONAL"
}
RedemptionFiltersRq
Fields
| Input Field | Description |
|---|---|
country - String
|
|
id - ID
|
|
inventoryId - ID
|
|
name - String
|
|
organization - OrganizationFiltersRq
|
|
recSourceId - ID
|
|
recurringRecSourceType - RecurringRecSourceType
|
|
redemptionStatementBcStatus - RedemptionStatementBcStatus
|
|
redemptionStatementId - String
|
|
registry - String
|
|
status - RedemptionStatus
|
|
tags - [String!]
|
|
tenantId - ID
|
|
trustLink - TrustLink
|
|
type - DeliveryType
|
Example
{
"country": "US",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"inventoryId": "1_1",
"name": "Some Name",
"organization": OrganizationFiltersRq,
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"recurringRecSourceType": "GreenTariff",
"redemptionStatementBcStatus": "REDEMPTION_STATEMENT_NOT_SET",
"redemptionStatementId": "abc123",
"registry": "xyz789",
"status": "APPROVED",
"tags": ["xyz789"],
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"trustLink": "ONE_DIRECTIONAL",
"type": "ONE_TIME"
}
RedemptionListRq
Fields
| Input Field | Description |
|---|---|
filters - RedemptionFiltersRq
|
|
pagination - PaginationRq
|
|
sort - RedemptionSortRq
|
Example
{
"filters": RedemptionFiltersRq,
"pagination": PaginationRq,
"sort": RedemptionSortRq
}
RedemptionListRs
Fields
| Field Name | Description |
|---|---|
data - [RedemptionDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [RedemptionDTO],
"pagination": PaginationRs
}
RedemptionSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"createdAt"
RedemptionSortRq
Fields
| Input Field | Description |
|---|---|
field - RedemptionSortField!
|
|
order - SortOrder
|
Example
{"field": "createdAt", "order": "ASC"}
RedemptionStatementBcStatus
Description
Redemption statement Blockchain-dependent status lifecycle.
- REDEMPTION_STATEMENT_NOT_SET: Statement eather not uploaded or blockchain not enabled
- REDEMPTION_STATEMENT_SET_REQUESTED: Statement upload initiated, begins async deployment
- REDEMPTION_STATEMENT_SET_TRIGGERED: Blockchain processing started
- REDEMPTION_STATEMENT_SET: Statement successfully deployed on blockchain
When blockchain is enabled, the async deployment process can be tracked through the field status:
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"REDEMPTION_STATEMENT_NOT_SET"
RedemptionStatus
Description
Redemption status lifecycle.
Basic states (always available):
- CREATED: Initial state, can be modified
- APPROVED: All certificates are approved and in not DRAFT status
- USED: All certificates have been totally used/claimed
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVED"
RefreshApiKeyRq
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "some-email@example.org"}
RefreshApiKeyRs
Fields
| Field Name | Description |
|---|---|
apiKey - String
|
Example
{"apiKey": "abc123"}
RegisterRq
ReplyToProofProposalRq
ReplyToProofProposalsRq
Fields
| Input Field | Description |
|---|---|
replies - [ReplyToProofProposalRq!]!
|
|
submissionToken - ID!
|
Example
{
"replies": [ReplyToProofProposalRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
Role
Description
User roles in the system. States:
- SuperAdmin: Full system access
- TenantManager: Manages multiple tenants
- OrganizationAdmin: Manages single organization
- Auditor: Read-only access to organization data
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Auditor"
Scope3AllocationAmountsDTO
Example
{
"allocatedCleanEnergyAmountInWh": "1000",
"allocatedConsumedEnergyAmountInWh": "1000",
"totalCleanEnergyAmountInWh": "1000",
"totalConsumedEnergyAmountInWh": "1000"
}
Scope3AllocationDTO
Fields
| Field Name | Description |
|---|---|
cleanEnergyAmountInWh - String!
|
|
consumedEnergyAmountInWh - String!
|
|
consumer - ConsumerDTO!
|
|
endDate - String!
|
|
id - ID!
|
|
organization - OrganizationDTO!
|
|
startDate - String!
|
Example
{
"cleanEnergyAmountInWh": "1000",
"consumedEnergyAmountInWh": "1000",
"consumer": ConsumerDTO,
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organization": OrganizationDTO,
"startDate": "2022-01-01"
}
Scope3AllocationFiltersRq
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"endDate": "2022-12-31",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"organizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"startDate": "2022-01-01"
}
Scope3AllocationListRq
Fields
| Input Field | Description |
|---|---|
filters - Scope3AllocationFiltersRq
|
|
pagination - PaginationRq
|
|
sort - Scope3AllocationSortRq
|
Example
{
"filters": Scope3AllocationFiltersRq,
"pagination": PaginationRq,
"sort": Scope3AllocationSortRq
}
Scope3AllocationListRs
Fields
| Field Name | Description |
|---|---|
data - [Scope3AllocationDTO!]!
|
|
pagination - PaginationRs
|
Example
{
"data": [Scope3AllocationDTO],
"pagination": PaginationRs
}
Scope3AllocationSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"cleanEnergyAmountInWh"
Scope3AllocationSortRq
Fields
| Input Field | Description |
|---|---|
field - Scope3AllocationSortField!
|
|
order - SortOrder
|
Example
{"field": "cleanEnergyAmountInWh", "order": "ASC"}
Scope3AllocationSummaryDTO
Description
Scope 3 allocation summary statistics. Includes clean and consumed energy amounts.
Example
{
"numberOfAllocations": 42,
"totalCleanAmountInWh": "1000",
"totalConsumedAmountInWh": "1000"
}
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringFilter
Fields
| Input Field | Description |
|---|---|
ignoreCase - Boolean
|
|
type - StringFilterType
|
|
value - String!
|
Example
{
"ignoreCase": true,
"type": "contains",
"value": "xyz789"
}
StringFilterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"contains"
SubscriptionDTO
Fields
| Field Name | Description |
|---|---|
checkoutSessionUrl - String!
|
|
consumers - [ConsumerDTO!]!
|
|
currentPrice - SubscriptionPriceDTO!
|
|
endDate - String!
|
|
energyAmountInWh - String!
|
|
id - ID!
|
|
offers - [OfferDTO!]!
|
|
percentGreenGoal - Int
|
|
preferences - MatchingPreferencesDTO
|
|
priorityList - PriorityListDTO
|
|
startDate - String!
|
|
status - SubscriptionStatus!
|
Example
{
"checkoutSessionUrl": "xyz789",
"consumers": [ConsumerDTO],
"currentPrice": SubscriptionPriceDTO,
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"offers": [OfferDTO],
"percentGreenGoal": 42,
"preferences": MatchingPreferencesDTO,
"priorityList": PriorityListDTO,
"startDate": "2022-01-01",
"status": "ACTIVE"
}
SubscriptionFiltersRq
Fields
| Input Field | Description |
|---|---|
anyOrganizationId - ID
|
|
consumer - ConsumerFiltersRq
|
|
id - ID
|
|
offerId - ID
|
|
priorityListId - ID
|
|
startDate - String
|
|
status - SubscriptionStatus
|
Example
{
"anyOrganizationId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"consumer": ConsumerFiltersRq,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"offerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"priorityListId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"startDate": "2022-01-01",
"status": "ACTIVE"
}
SubscriptionListRq
Fields
| Input Field | Description |
|---|---|
filters - SubscriptionFiltersRq
|
|
pagination - PaginationRq
|
|
sort - SubscriptionSortRq
|
Example
{
"filters": SubscriptionFiltersRq,
"pagination": PaginationRq,
"sort": SubscriptionSortRq
}
SubscriptionListRs
Fields
| Field Name | Description |
|---|---|
data - [SubscriptionDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [SubscriptionDTO],
"pagination": PaginationRs
}
SubscriptionPriceDTO
SubscriptionSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"startDate"
SubscriptionSortRq
Fields
| Input Field | Description |
|---|---|
field - SubscriptionSortField!
|
|
order - SortOrder
|
Example
{"field": "startDate", "order": "ASC"}
SubscriptionStatus
Description
Subscription lifecycle status. States:
- PENDING_PAYMENT: Created but not yet paid
- EXPIRED: End date reached
- ACTIVE: Paid and within subscription period, cannot be modified
- CANCELLED: Manually cancelled before end date
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
SuccessRs
TenantFeatureLimitDTO
Fields
| Field Name | Description |
|---|---|
allocations - FeatureLimitUsageDTO!
|
|
greenTariffs - FeatureLimitUsageDTO!
|
|
internalConsumers - FeatureLimitUsageDTO!
|
|
onsites - FeatureLimitUsageDTO!
|
|
orders - FeatureLimitUsageDTO!
|
|
organization - OrganizationDTO!
|
|
ppas - FeatureLimitUsageDTO!
|
|
proofs - FeatureLimitUsageDTO!
|
|
redemptions - FeatureLimitUsageDTO!
|
|
unbundled - FeatureLimitUsageDTO!
|
|
valueChainConsumers - FeatureLimitUsageDTO!
|
|
valueChainPartners - FeatureLimitUsageDTO!
|
Example
{
"allocations": FeatureLimitUsageDTO,
"greenTariffs": FeatureLimitUsageDTO,
"internalConsumers": FeatureLimitUsageDTO,
"onsites": FeatureLimitUsageDTO,
"orders": FeatureLimitUsageDTO,
"organization": OrganizationDTO,
"ppas": FeatureLimitUsageDTO,
"proofs": FeatureLimitUsageDTO,
"redemptions": FeatureLimitUsageDTO,
"unbundled": FeatureLimitUsageDTO,
"valueChainConsumers": FeatureLimitUsageDTO,
"valueChainPartners": FeatureLimitUsageDTO
}
TenantPermissionDTO
Description
Tenant permission information. Contains:
- Owner and accessing tenant details
- Permission type (READ/WRITE)
- Granted rights
Fields
| Field Name | Description |
|---|---|
accessingTenant - OrganizationDTO!
|
|
id - ID!
|
|
ownerTenant - OrganizationDTO!
|
|
rights - [PermissionRight!]
|
|
type - PermissionType!
|
Example
{
"accessingTenant": OrganizationDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"ownerTenant": OrganizationDTO,
"rights": ["ALLOCATION"],
"type": "READ"
}
TenantPermissionListRq
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
pagination - PaginationRq
|
|
rights - [PermissionRight!]
|
|
type - PermissionType
|
Example
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"pagination": PaginationRq,
"rights": ["ALLOCATION"],
"type": "READ"
}
TenantPermissionListRs
Fields
| Field Name | Description |
|---|---|
data - [TenantPermissionDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [TenantPermissionDTO],
"pagination": PaginationRs
}
TenantSettingsDTO
Fields
| Field Name | Description |
|---|---|
blockchainEnabled - Boolean
|
|
defaultCurrency - String
|
|
onboardingMode - OnboardingMode
|
|
pagesHiddenFromPublic - Boolean
|
|
percentGreenGoal - Int!
|
|
reportingTimeframeToleranceInMonths - Int
|
|
triggerProofInsteadOfProofProposalAutomatically - Boolean
|
|
triggerProofProposalAutomatically - Boolean
|
Example
{
"blockchainEnabled": true,
"defaultCurrency": "USD",
"onboardingMode": "SIMPLE",
"pagesHiddenFromPublic": true,
"percentGreenGoal": 42,
"reportingTimeframeToleranceInMonths": 0,
"triggerProofInsteadOfProofProposalAutomatically": true,
"triggerProofProposalAutomatically": false
}
TenantSettingsRq
Description
Tenant configuration settings. Settings affect:
- Onboarding process complexity
- Automatic proof generation
- Blockchain interaction
- Reporting timeframes
- UI visibility
Fields
| Input Field | Description |
|---|---|
blockchainEnabled - Boolean
|
|
defaultCurrency - String
|
|
onboardingMode - OnboardingMode
|
|
pagesHiddenFromPublic - Boolean
|
|
percentGreenGoal - Int
|
|
reportingTimeframeToleranceInMonths - Int
|
|
triggerProofInsteadOfProofProposalAutomatically - Boolean
|
|
triggerProofProposalAutomatically - Boolean
|
Example
{
"blockchainEnabled": false,
"defaultCurrency": "abc123",
"onboardingMode": "ADVANCED",
"pagesHiddenFromPublic": false,
"percentGreenGoal": 42,
"reportingTimeframeToleranceInMonths": 42,
"triggerProofInsteadOfProofProposalAutomatically": false,
"triggerProofProposalAutomatically": false
}
TrustLink
Description
Trust relationship type. Types:
- ONE_DIRECTIONAL: Single direction trust
- TWO_DIRECTIONAL: Mutual trust between parties
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ONE_DIRECTIONAL"
UpdateCertificateRq
Fields
| Input Field | Description |
|---|---|
energyAmountInWh - String
|
|
externalId - String
|
|
generationEnd - String
|
|
generationStart - String
|
|
generatorId - ID
|
|
id - ID!
|
|
isGreenECertified - Boolean
|
|
label - String
|
|
markAsCreated - Boolean
|
|
productType - ProductType
|
|
providerReferenceNumber - String
|
|
recSourceDistributions - [CreateCertificateRecSourceDistributionRq!]
|
|
recSourceId - ID
|
|
supplierId - ID
|
Example
{
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"generationEnd": "2022-12-31",
"generationStart": "2022-01-01",
"generatorId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"isGreenECertified": false,
"label": "SOME_LABEL",
"markAsCreated": false,
"productType": "EUGO",
"providerReferenceNumber": "abc123",
"recSourceDistributions": [
CreateCertificateRecSourceDistributionRq
],
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"supplierId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
}
UpdateCertificatesRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateCertificateRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateCertificateRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateConsumerRq
Fields
| Input Field | Description |
|---|---|
address - String
|
|
data - [CreateConsumerFieldRq!]
|
|
deliveryPartnerIds - [ID!]
|
|
description - String
|
|
documentIds - [ID!]
|
|
emissionsFactor - ConsumerEmissionsFactorRq
|
|
estimatedDailyConsumptionInWh - String
|
|
id - ID!
|
|
imageIds - [ID!]
|
|
latitude - String
|
|
location - LocationRq
|
|
longitude - String
|
|
measuringPartnerIds - [ID!]
|
|
metadataId - ID
|
|
name - String
|
|
percentGreenGoal - Int
|
|
productType - ProductType
|
|
tags - [String!]
|
Example
{
"address": "Some Address 123",
"data": [CreateConsumerFieldRq],
"deliveryPartnerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"documentIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"emissionsFactor": [{"value": 10, "unit": "g_per_Wh"}],
"estimatedDailyConsumptionInWh": 10000,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"imageIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"latitude": "xyz789",
"location": LocationRq,
"longitude": "abc123",
"measuringPartnerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"metadataId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"name": "Some Name",
"percentGreenGoal": 42,
"productType": "EUGO",
"tags": ["abc123"]
}
UpdateConsumersRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateConsumerRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateConsumerRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateConsumptionRq
Description
Update an existing consumption. Restrictions:
- Only SuperAdmin can update energyAmountInWh
- Cannot change visibility from PUBLIC to PRIVATE
- Updated dates cannot overlap with other consumptions
Fields
| Input Field | Description |
|---|---|
documentIds - [ID!]
|
|
endDate - String
|
|
energyAmountInWh - String
|
|
externalId - String
|
|
id - ID!
|
|
label - String
|
|
percentGreenGoal - Int
|
|
period - RecurringTimePeriod
|
|
startDate - String
|
|
visibility - ConsumptionVisibility
|
Example
{
"documentIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"percentGreenGoal": 42,
"period": "DAILY",
"startDate": "2022-01-01",
"visibility": "PRIVATE"
}
UpdateConsumptionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateConsumptionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateConsumptionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateGeneratorRq
Example
{
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"imageIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"impactStories": ["xyz789"],
"latitude": "abc123",
"links": ["xyz789"],
"longitude": "xyz789",
"name": "Some Name",
"nameplateCapacityInW": "Some Name",
"registryGeneratorId": "abc123",
"support": "xyz789"
}
UpdateGeneratorsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateGeneratorRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateGeneratorRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateOrganizationRq
Fields
| Input Field | Description |
|---|---|
address - String
|
|
city - String
|
|
colorPrimary - String
|
|
colorSecondary - String
|
|
companyName - String
|
|
customerIds - [ID!]
|
|
description - String
|
|
email - String
|
|
externalId - String
|
|
goals - String
|
|
id - ID!
|
|
imageIds - [ID!]
|
|
inventoryIds - [String!]
|
|
isRecProvider - Boolean
|
|
location - LocationRq
|
|
logoId - ID
|
|
mainCommercialContactEmail - String
|
|
mainCommercialContactName - String
|
|
mainTechnicalContactEmail - String
|
|
mainTechnicalContactName - String
|
|
name - String
|
|
partnershipText - String
|
|
publicEmail - String
|
|
settings - TenantSettingsRq
|
|
shortText - String
|
|
social - String
|
|
supplierIds - [ID!]
|
|
tags - [String!]
|
|
vat - String
|
|
website - String
|
|
zip - String
|
Example
{
"address": "Some Address 123",
"city": "San Francisco",
"colorPrimary": "xyz789",
"colorSecondary": "xyz789",
"companyName": "Some Name",
"customerIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"description": "This is a description",
"email": "some-email@example.org",
"externalId": "SOME_EXTERNAL_ID-1234",
"goals": "abc123",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"imageIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"inventoryIds": ["1_1"],
"isRecProvider": true,
"location": LocationRq,
"logoId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"mainCommercialContactEmail": "some-email@example.org",
"mainCommercialContactName": "Some Name",
"mainTechnicalContactEmail": "some-email@example.org",
"mainTechnicalContactName": "Some Name",
"name": "Some Name",
"partnershipText": "xyz789",
"publicEmail": "some-email@example.org",
"settings": TenantSettingsRq,
"shortText": "xyz789",
"social": "@SomeHandle",
"supplierIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"tags": ["abc123"],
"vat": "xyz789",
"website": "https://example.org",
"zip": "92704"
}
UpdateOrganizationsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateOrganizationRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateOrganizationRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdatePriorityListItemRq
UpdatePriorityListItemsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdatePriorityListItemRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdatePriorityListItemRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdatePriorityListRq
Example
{
"description": "This is a description",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"itemIds": [
"9b67d28f-f37e-4aab-bcf5-a2dc353079a1"
],
"name": "Some Name",
"tags": ["xyz789"]
}
UpdatePriorityListsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdatePriorityListRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdatePriorityListRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateRecSourceRq
Fields
| Input Field | Description |
|---|---|
currency - String
|
|
deliveryDate - String
|
|
endDate - String
|
|
energyAmountInWh - String
|
|
energyAmountPercentage - Float
|
|
externalId - String
|
|
id - ID!
|
|
label - String
|
|
locations - [LocationRq!]
|
|
orderDate - String
|
|
pricePerWh - Float
|
|
providerId - ID
|
|
recurringDeliveryPeriod - RecurringTimePeriod
|
|
startDate - String
|
Example
{
"currency": "abc123",
"deliveryDate": "2022-09-21",
"endDate": "2022-12-31",
"energyAmountInWh": "1000",
"energyAmountPercentage": "1000",
"externalId": "SOME_EXTERNAL_ID-1234",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"label": "SOME_LABEL",
"locations": [LocationRq],
"orderDate": "2022-09-21",
"pricePerWh": 987.65,
"providerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"recurringDeliveryPeriod": "DAILY",
"startDate": "2022-01-01"
}
UpdateRecSourcesRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateRecSourceRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateRecSourceRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateRedemptionRq
Example
{
"comment": "Some random comment",
"energyAmountInWh": "1000",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"name": "Some Name",
"recSourceId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"redemptionStatementId": "eed15f92-e43b-4430-bf27-b0c433d99329",
"registry": "abc123",
"tags": ["abc123"]
}
UpdateRedemptionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateRedemptionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateRedemptionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateScope3AllocationRq
UpdateScope3AllocationsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateScope3AllocationRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateScope3AllocationRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UpdateSubscriptionRq
UpdateTenantPermissionRq
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
rights - [PermissionRight!]!
|
Example
{
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"rights": ["ALLOCATION"]
}
UpdateTenantPermissionsRq
Fields
| Input Field | Description |
|---|---|
csvFileId - ID
|
|
data - [UpdateTenantPermissionRq!]
|
|
submissionToken - ID!
|
Example
{
"csvFileId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"data": [UpdateTenantPermissionRq],
"submissionToken": "1699281292576:9a0b3ff48b"
}
UserInfoRs
Example
{
"email": "some-email@example.org",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"mfaEnabled": true,
"role": "Auditor",
"tenantId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"verified": false
}
UserInvitationDTO
UtilityAccountDTO
Fields
| Field Name | Description |
|---|---|
bills - JSON
|
|
consumer - ConsumerDTO!
|
|
id - ID!
|
|
meters - JSON
|
|
status - UtilityAccountStatus!
|
Example
{
"bills": {},
"consumer": ConsumerDTO,
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"meters": {},
"status": "ACTIVE"
}
UtilityAccountFiltersRq
Fields
| Input Field | Description |
|---|---|
consumerId - ID
|
|
id - ID
|
|
status - UtilityAccountStatus
|
Example
{
"consumerId": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"id": "9b67d28f-f37e-4aab-bcf5-a2dc353079a1",
"status": "ACTIVE"
}
UtilityAccountListRq
Fields
| Input Field | Description |
|---|---|
filters - UtilityAccountFiltersRq
|
|
pagination - PaginationRq
|
Example
{
"filters": UtilityAccountFiltersRq,
"pagination": PaginationRq
}
UtilityAccountListRs
Fields
| Field Name | Description |
|---|---|
data - [UtilityAccountDTO!]!
|
|
pagination - PaginationRs
|
Example
{
"data": [UtilityAccountDTO],
"pagination": PaginationRs
}
UtilityAccountStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
VerifyAITaskResultRq
VerifyEmailRq
W3BlockchainPropertiesDTO
Fields
| Field Name | Description |
|---|---|
agreementFactory - String!
|
|
agreementFactoryDeployTransaction - String!
|
|
batchFactory - String!
|
|
batchFactoryDeployTransaction - String!
|
|
default - Boolean!
|
|
inventoryId - String!
|
|
lowBalanceThreshold - String!
|
|
netId - Int!
|
|
networkBlockExplorerUrl - String!
|
|
networkName - String!
|
|
platformOperatorBlockchainAddress - String!
|
|
protocolVersion - String!
|
|
registry - String!
|
|
registryDeployTransaction - String!
|
|
rpcNode - String!
|
|
topic - Int!
|
Example
{
"agreementFactory": "xyz789",
"agreementFactoryDeployTransaction": "xyz789",
"batchFactory": "xyz789",
"batchFactoryDeployTransaction": "abc123",
"default": true,
"inventoryId": "1_1",
"lowBalanceThreshold": "abc123",
"netId": 42,
"networkBlockExplorerUrl": "abc123",
"networkName": "Some Name",
"platformOperatorBlockchainAddress": "0x7c62D2e07E94D7bBCE39690744A063084d2D37c2",
"protocolVersion": "abc123",
"registry": "xyz789",
"registryDeployTransaction": "xyz789",
"rpcNode": "xyz789",
"topic": 42
}
W3BlockchainPropertiesGetRq
Fields
| Input Field | Description |
|---|---|
default - Boolean
|
|
inventoryId - String
|
|
pagination - PaginationRq
|
Example
{
"default": true,
"inventoryId": "1_1",
"pagination": PaginationRq
}
W3BlockchainPropertiesListRs
Fields
| Field Name | Description |
|---|---|
data - [W3BlockchainPropertiesDTO!]
|
|
pagination - PaginationRs
|
Example
{
"data": [W3BlockchainPropertiesDTO],
"pagination": PaginationRs
}